/AWS1/CL_ECSSERVICEDEPLOYMENT¶
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 .
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_servicedeploymentarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The ARN of the service deployment.
iv_servicearn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The ARN of the service for this service deployment.
iv_clusterarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The ARN of the cluster that hosts the service.
iv_createdat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP¶
The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
iv_startedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP¶
The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
iv_finishedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP¶
The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
iv_stoppedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP¶
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.
iv_updatedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP¶
The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
it_sourceservicerevisions TYPE /AWS1/CL_ECSSVCREVISIONSUMM=>TT_SERVICEREVISIONSSUMMARYLIST TT_SERVICEREVISIONSSUMMARYLIST¶
The currently deployed workload configuration.
io_targetservicerevision TYPE REF TO /AWS1/CL_ECSSVCREVISIONSUMM /AWS1/CL_ECSSVCREVISIONSUMM¶
The workload configuration being deployed.
iv_status TYPE /AWS1/ECSSVCDEPLOYMENTSTATUS /AWS1/ECSSVCDEPLOYMENTSTATUS¶
The service deployment state.
iv_statusreason TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
iv_lifecyclestage TYPE /AWS1/ECSSVCDEPLOYMENTLCSTAGE /AWS1/ECSSVCDEPLOYMENTLCSTAGE¶
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.
io_deploymentconfiguration TYPE REF TO /AWS1/CL_ECSDEPLOYMENTCONF /AWS1/CL_ECSDEPLOYMENTCONF¶
deploymentConfiguration
io_rollback TYPE REF TO /AWS1/CL_ECSROLLBACK /AWS1/CL_ECSROLLBACK¶
The rollback options the service deployment uses when the deployment fails.
io_deploymentcircuitbreaker TYPE REF TO /AWS1/CL_ECSSVCDEPLOYMENTCIR00 /AWS1/CL_ECSSVCDEPLOYMENTCIR00¶
The circuit breaker configuration that determines a service deployment failed.
io_alarms TYPE REF TO /AWS1/CL_ECSSVCDEPLOYMENTALRMS /AWS1/CL_ECSSVCDEPLOYMENTALRMS¶
The CloudWatch alarms that determine when a service deployment fails.
Queryable Attributes¶
serviceDeploymentArn¶
The ARN of the service deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEDEPLOYMENTARN() |
Getter for SERVICEDEPLOYMENTARN, with configurable default |
ASK_SERVICEDEPLOYMENTARN() |
Getter for SERVICEDEPLOYMENTARN w/ exceptions if field has n |
HAS_SERVICEDEPLOYMENTARN() |
Determine if SERVICEDEPLOYMENTARN has a value |
serviceArn¶
The ARN of the service for this service deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEARN() |
Getter for SERVICEARN, with configurable default |
ASK_SERVICEARN() |
Getter for SERVICEARN w/ exceptions if field has no value |
HAS_SERVICEARN() |
Determine if SERVICEARN has a value |
clusterArn¶
The ARN of the cluster that hosts the service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERARN() |
Getter for CLUSTERARN, with configurable default |
ASK_CLUSTERARN() |
Getter for CLUSTERARN w/ exceptions if field has no value |
HAS_CLUSTERARN() |
Determine if CLUSTERARN has a value |
createdAt¶
The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
startedAt¶
The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTEDAT() |
Getter for STARTEDAT, with configurable default |
ASK_STARTEDAT() |
Getter for STARTEDAT w/ exceptions if field has no value |
HAS_STARTEDAT() |
Determine if STARTEDAT has a value |
finishedAt¶
The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FINISHEDAT() |
Getter for FINISHEDAT, with configurable default |
ASK_FINISHEDAT() |
Getter for FINISHEDAT w/ exceptions if field has no value |
HAS_FINISHEDAT() |
Determine if FINISHEDAT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STOPPEDAT() |
Getter for STOPPEDAT, with configurable default |
ASK_STOPPEDAT() |
Getter for STOPPEDAT w/ exceptions if field has no value |
HAS_STOPPEDAT() |
Determine if STOPPEDAT has a value |
updatedAt¶
The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
sourceServiceRevisions¶
The currently deployed workload configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCESERVICEREVISIONS() |
Getter for SOURCESERVICEREVISIONS, with configurable default |
ASK_SOURCESERVICEREVISIONS() |
Getter for SOURCESERVICEREVISIONS w/ exceptions if field has |
HAS_SOURCESERVICEREVISIONS() |
Determine if SOURCESERVICEREVISIONS has a value |
targetServiceRevision¶
The workload configuration being deployed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETSERVICEREVISION() |
Getter for TARGETSERVICEREVISION |
status¶
The service deployment state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
statusReason¶
Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LIFECYCLESTAGE() |
Getter for LIFECYCLESTAGE, with configurable default |
ASK_LIFECYCLESTAGE() |
Getter for LIFECYCLESTAGE w/ exceptions if field has no valu |
HAS_LIFECYCLESTAGE() |
Determine if LIFECYCLESTAGE has a value |
deploymentConfiguration¶
deploymentConfiguration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTCONFIGURATION() |
Getter for DEPLOYMENTCONFIGURATION |
rollback¶
The rollback options the service deployment uses when the deployment fails.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLLBACK() |
Getter for ROLLBACK |
deploymentCircuitBreaker¶
The circuit breaker configuration that determines a service deployment failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTCIRCUITBREAKER() |
Getter for DEPLOYMENTCIRCUITBREAKER |
alarms¶
The CloudWatch alarms that determine when a service deployment fails.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALARMS() |
Getter for ALARMS |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SERVICEDEPLOYMENTS¶
TYPES TT_SERVICEDEPLOYMENTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSSERVICEDEPLOYMENT WITH DEFAULT KEY
.