Amazonka.ECS.Types.Deployment

Documentation

data Deployment

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

See: newDeployment smart constructor.

Constructors

Deployment'

Fields

• capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]

  The capacity provider strategy that the deployment is using.

• createdAt :: Maybe POSIX

  The Unix timestamp for the time when the service deployment was created.

• desiredCount :: Maybe Int

  The most recent desired count of tasks that was specified for the service to deploy or maintain.

• failedTasks :: Maybe Int

  The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

  Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

• id :: Maybe Text

  The ID of the deployment.

• launchType :: Maybe LaunchType

  The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

• networkConfiguration :: Maybe NetworkConfiguration

  The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

• pendingCount :: Maybe Int

  The number of tasks in the deployment that are in the PENDING status.

• platformFamily :: Maybe Text

  The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

  All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

• platformVersion :: Maybe Text

  The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

• rolloutState :: Maybe DeploymentRolloutState

  The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

  The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

• rolloutStateReason :: Maybe Text

  A description of the rollout state of a deployment.

• runningCount :: Maybe Int

  The number of tasks in the deployment that are in the RUNNING status.

• serviceConnectConfiguration :: Maybe ServiceConnectConfiguration

  The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

  The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

  Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

• serviceConnectResources :: Maybe [ServiceConnectServiceResource]

  The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

• status :: Maybe Text

  The status of the deployment. The following describes each state.

  PRIMARY

  The most recent deployment of a service.

  ACTIVE

  A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

  INACTIVE

  A deployment that has been completely replaced.

• taskDefinition :: Maybe Text

  The most recent task definition that was specified for the tasks in the service to use.

• updatedAt :: Maybe POSIX

  The Unix timestamp for the time when the service deployment was last updated.

Instances

FromJSON Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

Generic Deployment

Defined in Amazonka.ECS.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Read Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

NFData Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

rnf :: Deployment -> ()

Eq Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

(/=) :: Deployment -> Deployment -> Bool

Hashable Deployment

Defined in Amazonka.ECS.Types.Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

type Rep Deployment

Defined in Amazonka.ECS.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.ECS.Types.Deployment" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem])) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "desiredCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "failedTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType))) :*: (S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)) :*: (S1 ('MetaSel ('Just "pendingCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rolloutState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentRolloutState))) :*: (S1 ('MetaSel ('Just "rolloutStateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "serviceConnectConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceConnectConfiguration)) :*: S1 ('MetaSel ('Just "serviceConnectResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceConnectServiceResource]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))))

newDeployment :: Deployment

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityProviderStrategy:Deployment', deployment_capacityProviderStrategy - The capacity provider strategy that the deployment is using.

$sel:createdAt:Deployment', deployment_createdAt - The Unix timestamp for the time when the service deployment was created.

$sel:desiredCount:Deployment', deployment_desiredCount - The most recent desired count of tasks that was specified for the service to deploy or maintain.

$sel:failedTasks:Deployment', deployment_failedTasks - The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

$sel:id:Deployment', deployment_id - The ID of the deployment.

$sel:launchType:Deployment', deployment_launchType - The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

$sel:networkConfiguration:Deployment', deployment_networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

$sel:pendingCount:Deployment', deployment_pendingCount - The number of tasks in the deployment that are in the PENDING status.

$sel:platformFamily:Deployment', deployment_platformFamily - The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

$sel:platformVersion:Deployment', deployment_platformVersion - The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

$sel:rolloutState:Deployment', deployment_rolloutState - The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

$sel:rolloutStateReason:Deployment', deployment_rolloutStateReason - A description of the rollout state of a deployment.

$sel:runningCount:Deployment', deployment_runningCount - The number of tasks in the deployment that are in the RUNNING status.

$sel:serviceConnectConfiguration:Deployment', deployment_serviceConnectConfiguration - The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:serviceConnectResources:Deployment', deployment_serviceConnectResources - The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

$sel:status:Deployment', deployment_status - The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

$sel:taskDefinition:Deployment', deployment_taskDefinition - The most recent task definition that was specified for the tasks in the service to use.

$sel:updatedAt:Deployment', deployment_updatedAt - The Unix timestamp for the time when the service deployment was last updated.

deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy that the deployment is using.

deployment_createdAt :: Lens' Deployment (Maybe UTCTime)

The Unix timestamp for the time when the service deployment was created.

deployment_desiredCount :: Lens' Deployment (Maybe Int)

The most recent desired count of tasks that was specified for the service to deploy or maintain.

deployment_failedTasks :: Lens' Deployment (Maybe Int)

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

deployment_id :: Lens' Deployment (Maybe Text)

The ID of the deployment.

deployment_launchType :: Lens' Deployment (Maybe LaunchType)

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

deployment_pendingCount :: Lens' Deployment (Maybe Int)

The number of tasks in the deployment that are in the PENDING status.

deployment_platformFamily :: Lens' Deployment (Maybe Text)

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

deployment_platformVersion :: Lens' Deployment (Maybe Text)

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState)

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

deployment_rolloutStateReason :: Lens' Deployment (Maybe Text)

A description of the rollout state of a deployment.

deployment_runningCount :: Lens' Deployment (Maybe Int)

The number of tasks in the deployment that are in the RUNNING status.

deployment_serviceConnectConfiguration :: Lens' Deployment (Maybe ServiceConnectConfiguration)

The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

deployment_serviceConnectResources :: Lens' Deployment (Maybe [ServiceConnectServiceResource])

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

deployment_status :: Lens' Deployment (Maybe Text)

The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

deployment_taskDefinition :: Lens' Deployment (Maybe Text)

The most recent task definition that was specified for the tasks in the service to use.

deployment_updatedAt :: Lens' Deployment (Maybe UTCTime)

The Unix timestamp for the time when the service deployment was last updated.