Deployment¶
Structure Class¶
dataclass
¶
Bases: _SerdeShape
The details of an Amazon ECS service deployment. This is used only when
a service uses the ECS deployment controller type.
Attributes¶
class-attribute
instance-attribute
¶
capacity_provider_strategy: list[CapacityProviderStrategyItem] | None = ...
The capacity provider strategy that the deployment is using.
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The Unix timestamp for the time when the service deployment was created.
class-attribute
instance-attribute
¶
desired_count: int = ...
The most recent desired count of tasks that was specified for the service to deploy or maintain.
class-attribute
instance-attribute
¶
failed_tasks: 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.
Note
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
class-attribute
instance-attribute
¶
fargate_ephemeral_storage: DeploymentEphemeralStorage | None = ...
The Fargate ephemeral storage settings for the deployment.
class-attribute
instance-attribute
¶
launch_type: str | None = ...
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.
class-attribute
instance-attribute
¶
network_configuration: NetworkConfiguration | None = ...
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
class-attribute
instance-attribute
¶
pending_count: int = ...
The number of tasks in the deployment that are in the PENDING status.
class-attribute
instance-attribute
¶
platform_family: str | None = ...
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..
class-attribute
instance-attribute
¶
platform_version: str | None = ...
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.
class-attribute
instance-attribute
¶
rollout_state: str | None = ...
Note
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 turned on,
the deployment transitions to a FAILED state. A deployment in FAILED
state doesn't launch any new tasks. For more information, see
DeploymentCircuitBreaker.
class-attribute
instance-attribute
¶
rollout_state_reason: str | None = ...
A description of the rollout state of a deployment.
class-attribute
instance-attribute
¶
running_count: int = ...
The number of tasks in the deployment that are in the RUNNING status.
class-attribute
instance-attribute
¶
service_connect_configuration: ServiceConnectConfiguration | None = ...
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.
class-attribute
instance-attribute
¶
service_connect_resources: list[ServiceConnectServiceResource] | None = ...
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.
class-attribute
instance-attribute
¶
status: str | None = ...
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
PRIMARYdeployment. - INACTIVE
-
A deployment that has been completely replaced.
class-attribute
instance-attribute
¶
task_definition: str | None = ...
The most recent task definition that was specified for the tasks in the service to use.
class-attribute
instance-attribute
¶
updated_at: datetime | None = ...
The Unix timestamp for the time when the service deployment was last updated.
class-attribute
instance-attribute
¶
volume_configurations: list[ServiceVolumeConfiguration] | None = ...
The details of the volume that was configuredAtLaunch. You can
configure different settings like the size, throughput, volumeType, and
ecryption in
ServiceManagedEBSVolumeConfiguration.
The name of the volume must match the name from the task definition.
class-attribute
instance-attribute
¶
vpc_lattice_configurations: list[VpcLatticeConfiguration] | None = ...
The VPC Lattice configuration for the service deployment.