Skip to content

ECS  >  Structures  >  ServiceDeployment

ServiceDeployment

Structure Class

ServiceDeployment dataclass

Bases: _SerdeShape

Information about the service deployment.

Service deployments provide a comprehensive view of your deployments. For information about service deployments, see View service history using Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide .

Attributes

alarms class-attribute instance-attribute 
alarms: ServiceDeploymentAlarms | None = ...

The CloudWatch alarms that determine when a service deployment fails.

cluster_arn class-attribute instance-attribute 
cluster_arn: str | None = ...

The ARN of the cluster that hosts the service.

created_at class-attribute instance-attribute 
created_at: datetime | None = ...

The time the service deployment was created. The format is yyyy-MM-dd HH🇲🇲ss.SSSSSS.

deployment_circuit_breaker class-attribute instance-attribute 
deployment_circuit_breaker: ServiceDeploymentCircuitBreaker | None = ...

The circuit breaker configuration that determines a service deployment failed.

deployment_configuration class-attribute instance-attribute 
deployment_configuration: DeploymentConfiguration | None = ...

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

finished_at class-attribute instance-attribute 
finished_at: datetime | None = ...

The time the service deployment finished. The format is yyyy-MM-dd HH🇲🇲ss.SSSSSS.

lifecycle_hook_details class-attribute instance-attribute 
lifecycle_hook_details: list[DeploymentLifecycleHookDetail] | None = ...

The details of the lifecycle hooks for the current service deployment.

lifecycle_stage class-attribute instance-attribute 
lifecycle_stage: str | None = ...

The current lifecycle stage of the deployment. Possible values include:

  • RECONCILE_SERVICE

The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

  • PRE_SCALE_UP

The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

  • SCALE_UP

The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.

  • POST_SCALE_UP

The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

  • TEST_TRAFFIC_SHIFT

The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

  • POST_TEST_TRAFFIC_SHIFT

The test traffic shift is complete. The green service revision handles 100% of the test traffic.

  • PRE_PRODUCTION_TRAFFIC_SHIFT

Occurs before production traffic shift. For linear and canary deployments, this stage is invoked before every traffic shift step.

  • PRODUCTION_TRAFFIC_SHIFT

Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. For linear and canary deployments, this stage is invoked at every traffic shift step.

  • POST_PRODUCTION_TRAFFIC_SHIFT

The production traffic shift is complete.

  • BAKE_TIME

The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.

  • CLEAN_UP

The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.

rollback class-attribute instance-attribute 
rollback: Rollback | None = ...

The rollback options the service deployment uses when the deployment fails.

service_arn class-attribute instance-attribute 
service_arn: str | None = ...

The ARN of the service for this service deployment.

service_deployment_arn class-attribute instance-attribute 
service_deployment_arn: str | None = ...

The ARN of the service deployment.

source_service_revisions class-attribute instance-attribute 
source_service_revisions: list[ServiceRevisionSummary] | None = ...

The currently deployed workload configuration.

started_at class-attribute instance-attribute 
started_at: datetime | None = ...

The time the service deployment statred. The format is yyyy-MM-dd HH🇲🇲ss.SSSSSS.

status class-attribute instance-attribute 
status: str | None = ...

The service deployment state.

status_reason class-attribute instance-attribute 
status_reason: str | None = ...

Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.

stopped_at class-attribute instance-attribute 
stopped_at: datetime | None = ...

The time the service deployment stopped. The format is yyyy-MM-dd HH🇲🇲ss.SSSSSS.

The service deployment stops when any of the following actions happen:

  • A user manually stops the deployment

  • The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.

target_service_revision class-attribute instance-attribute 
target_service_revision: ServiceRevisionSummary | None = ...

The workload configuration being deployed.

updated_at class-attribute instance-attribute 
updated_at: datetime | None = ...

The time that the service deployment was last updated. The format is yyyy-MM-dd HH🇲🇲ss.SSSSSS.