/AWS1/CL_ECSDEPLEARLYSUCCCRIT¶
You can use early success criteria only with rolling deployment strategy.
The configuration that determines when a rolling update deployment is considered successful. Early success criteria defines the percentage of tasks that must be healthy before a deployment completes. It also controls whether Amazon ECS must remove the previous tasks before a deployment completes.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_enable TYPE /AWS1/ECSBOOLEAN /AWS1/ECSBOOLEAN¶
Specifies whether to use the early success criteria for the service deployment. When set to
false, the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value isfalse.When set to
true, Amazon ECS monitors the deployment to meet early success criteria. You must also specifyhealthyPercentandsourceServiceRevisionCleanup.
Optional arguments:¶
iv_healthypercent TYPE /AWS1/ECSHEALTHYPERCENTINTEGER /AWS1/ECSHEALTHYPERCENTINTEGER¶
The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service's
desiredCountand must be an integer between0and100. This value must be greater than or equal to theminimumHealthyPercentvalue.After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background.
iv_sourceservicerevsncleanup TYPE /AWS1/ECSSERVICEREVSNCLEANUP /AWS1/ECSSERVICEREVSNCLEANUP¶
The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:
BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.
DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.
Queryable Attributes¶
enable¶
Specifies whether to use the early success criteria for the service deployment. When set to
false, the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value isfalse.When set to
true, Amazon ECS monitors the deployment to meet early success criteria. You must also specifyhealthyPercentandsourceServiceRevisionCleanup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLE() |
Getter for ENABLE |
healthyPercent¶
The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service's
desiredCountand must be an integer between0and100. This value must be greater than or equal to theminimumHealthyPercentvalue.After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEALTHYPERCENT() |
Getter for HEALTHYPERCENT, with configurable default |
ASK_HEALTHYPERCENT() |
Getter for HEALTHYPERCENT w/ exceptions if field has no valu |
HAS_HEALTHYPERCENT() |
Determine if HEALTHYPERCENT has a value |
sourceServiceRevisionCleanup¶
The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:
BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.
DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCESVCREVSNCLEANUP() |
Getter for SOURCESERVICEREVISIONCLEANUP, with configurable d |
ASK_SOURCESVCREVSNCLEANUP() |
Getter for SOURCESERVICEREVISIONCLEANUP w/ exceptions if fie |
HAS_SOURCESVCREVSNCLEANUP() |
Determine if SOURCESERVICEREVISIONCLEANUP has a value |