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
- 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_IN_PROGRESS | ROLLBACK_SUCCESSFUL | ROLLBACK_FAILEDRequired: 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: