ServiceDeployment
¶
Source code in docs_src/capo_ecs/types/service_deployment.py
alarms
instance-attribute
¶
alarms: NotRequired[ServiceDeploymentAlarms]
The CloudWatch alarms that determine when a service deployment fails.
cluster_arn
instance-attribute
¶
cluster_arn: NotRequired[String]
The ARN of the cluster that hosts the service.
created_at
instance-attribute
¶
created_at: NotRequired[Timestamp]
The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
deployment_circuit_breaker
instance-attribute
¶
deployment_circuit_breaker: NotRequired[ServiceDeploymentCircuitBreaker]
The circuit breaker configuration that determines a service deployment failed.
deployment_configuration
instance-attribute
¶
deployment_configuration: NotRequired[DeploymentConfiguration]
finished_at
instance-attribute
¶
finished_at: NotRequired[Timestamp]
The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
lifecycle_hook_details
instance-attribute
¶
lifecycle_hook_details: NotRequired[DeploymentLifecycleHookDetailList]
The details of the lifecycle hooks for the current service deployment.
lifecycle_stage
instance-attribute
¶
lifecycle_stage: NotRequired[ServiceDeploymentLifecycleStage]
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
instance-attribute
¶
rollback: NotRequired[Rollback]
The rollback options the service deployment uses when the deployment fails.
service_arn
instance-attribute
¶
service_arn: NotRequired[String]
The ARN of the service for this service deployment.
service_deployment_arn
instance-attribute
¶
service_deployment_arn: NotRequired[String]
The ARN of the service deployment.
source_service_revisions
instance-attribute
¶
source_service_revisions: NotRequired[ServiceRevisionsSummaryList]
The currently deployed workload configuration.
started_at
instance-attribute
¶
started_at: NotRequired[Timestamp]
The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
status
instance-attribute
¶
status: NotRequired[ServiceDeploymentStatus]
The service deployment state.
status_reason
instance-attribute
¶
status_reason: NotRequired[String]
Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
stopped_at
instance-attribute
¶
stopped_at: NotRequired[Timestamp]
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.
target_service_revision
instance-attribute
¶
target_service_revision: NotRequired[ServiceRevisionSummary]
The workload configuration being deployed.