ServiceDeployment - Amazon Elastic Container Service
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ServiceDeployment

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 .

Contents

alarms

The CloudWatch alarms that determine when a service deployment fails.

Type: ServiceDeploymentAlarms object

Required: No

clusterArn

The ARN of the cluster that hosts the service.

Type: String

Required: No

createdAt

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

Type: Timestamp

Required: No

deploymentCircuitBreaker

The circuit breaker configuration that determines a service deployment failed.

Type: ServiceDeploymentCircuitBreaker object

Required: No

deploymentConfiguration

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

Type: DeploymentConfiguration object

Required: No

finishedAt

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

Type: Timestamp

Required: No

lifecycleStage

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.

  • 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.

  • 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.

Type: String

Valid Values: RECONCILE_SERVICE | PRE_SCALE_UP | SCALE_UP | POST_SCALE_UP | TEST_TRAFFIC_SHIFT | POST_TEST_TRAFFIC_SHIFT | PRODUCTION_TRAFFIC_SHIFT | POST_PRODUCTION_TRAFFIC_SHIFT | BAKE_TIME | CLEAN_UP

Required: No

rollback

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

Type: Rollback object

Required: No

serviceArn

The ARN of the service for this service deployment.

Type: String

Required: No

serviceDeploymentArn

The ARN of the service deployment.

Type: String

Required: No

sourceServiceRevisions

The currently deployed workload configuration.

Type: Array of ServiceRevisionSummary objects

Required: No

startedAt

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

Type: Timestamp

Required: No

status

The service deployment state.

Type: String

Valid Values: PENDING | SUCCESSFUL | STOPPED | STOP_REQUESTED | IN_PROGRESS | ROLLBACK_REQUESTED | ROLLBACK_IN_PROGRESS | ROLLBACK_SUCCESSFUL | ROLLBACK_FAILED

Required: No

statusReason

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

Type: String

Required: No

stoppedAt

The time the service deployment stopped. The format is yyyy-MM-dd HH:mm: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.

Type: Timestamp

Required: No

targetServiceRevision

The workload configuration being deployed.

Type: ServiceRevisionSummary object

Required: No

updatedAt

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: