public static interface DeploymentConfiguration.Builder extends SdkPojo, CopyableBuilder<DeploymentConfiguration.Builder,DeploymentConfiguration>
| Modifier and Type | Method and Description |
|---|---|
default DeploymentConfiguration.Builder |
deploymentCircuitBreaker(Consumer<DeploymentCircuitBreaker.Builder> deploymentCircuitBreaker)
|
DeploymentConfiguration.Builder |
deploymentCircuitBreaker(DeploymentCircuitBreaker deploymentCircuitBreaker)
|
DeploymentConfiguration.Builder |
maximumPercent(Integer maximumPercent)
If a service is using the rolling update (
ECS) deployment type, the maximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in the
RUNNING or PENDING state during a deployment, as a percentage of the
desiredCount (rounded down to the nearest integer). |
DeploymentConfiguration.Builder |
minimumHealthyPercent(Integer minimumHealthyPercent)
If a service is using the rolling update (
ECS) deployment type, the
minimumHealthyPercent represents a lower limit on the number of your service's tasks that must
remain in the RUNNING state during a deployment, as a percentage of the
desiredCount (rounded up to the nearest integer). |
equalsBySdkFields, sdkFieldscopyapplyMutation, buildDeploymentConfiguration.Builder deploymentCircuitBreaker(DeploymentCircuitBreaker deploymentCircuitBreaker)
The deployment circuit breaker can only be used for services using the rolling update (ECS)
deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
deploymentCircuitBreaker -
The deployment circuit breaker can only be used for services using the rolling update (
ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
default DeploymentConfiguration.Builder deploymentCircuitBreaker(Consumer<DeploymentCircuitBreaker.Builder> deploymentCircuitBreaker)
The deployment circuit breaker can only be used for services using the rolling update (ECS)
deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
This is a convenience method that creates an instance of theDeploymentCircuitBreaker.Builder
avoiding the need to create one manually via DeploymentCircuitBreaker.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to deploymentCircuitBreaker(DeploymentCircuitBreaker).
deploymentCircuitBreaker - a consumer that will call methods on DeploymentCircuitBreaker.BuilderdeploymentCircuitBreaker(DeploymentCircuitBreaker)DeploymentConfiguration.Builder maximumPercent(Integer maximumPercent)
If a service is using the rolling update (ECS) deployment type, the maximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in the
RUNNING or PENDING state during a deployment, as a percentage of the
desiredCount (rounded down to the nearest integer). This parameter enables you to define the
deployment batch size. For example, if your service is using the REPLICA service scheduler and
has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler
may start four new tasks before stopping the four older tasks (provided that the cluster resources required
to do this are available). The default maximumPercent value for a service using the
REPLICA service scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment
types and tasks that use the EC2 launch type, the maximum percent value is set to the default value
and is used to define the upper limit on the number of the tasks in the service that remain in the
RUNNING state while the container instances are in the DRAINING state. If the tasks
in the service use the Fargate launch type, the maximum percent value is not used, although it is returned
when describing your service.
maximumPercent - If a service is using the rolling update (ECS) deployment type, the
maximumPercent parameter represents an upper limit on the number of your service's tasks
that are allowed in the RUNNING or PENDING state during a deployment, as a
percentage of the desiredCount (rounded down to the nearest integer). This parameter
enables you to define the deployment batch size. For example, if your service is using the
REPLICA service scheduler and has a desiredCount of four tasks and a
maximumPercent value of 200%, the scheduler may start four new tasks before stopping the
four older tasks (provided that the cluster resources required to do this are available). The default
maximumPercent value for a service using the REPLICA service scheduler is
200%.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to
the default value and is used to define the upper limit on the number of the tasks in the service that
remain in the RUNNING state while the container instances are in the
DRAINING state. If the tasks in the service use the Fargate launch type, the maximum
percent value is not used, although it is returned when describing your service.
DeploymentConfiguration.Builder minimumHealthyPercent(Integer minimumHealthyPercent)
If a service is using the rolling update (ECS) deployment type, the
minimumHealthyPercent represents a lower limit on the number of your service's tasks that must
remain in the RUNNING state during a deployment, as a percentage of the
desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without
using additional cluster capacity. For example, if your service has a desiredCount of four tasks
and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up
cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40
seconds after a task reaches a RUNNING state before the task is counted towards the minimum
healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment
types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to
the default value and is used to define the lower limit on the number of the tasks in the service that remain
in the RUNNING state while the container instances are in the DRAINING state. If a
service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types
and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used,
although it is returned when describing your service.
minimumHealthyPercent - If a service is using the rolling update (ECS) deployment type, the
minimumHealthyPercent represents a lower limit on the number of your service's tasks that
must remain in the RUNNING state during a deployment, as a percentage of the
desiredCount (rounded up to the nearest integer). This parameter enables you to deploy
without using additional cluster capacity. For example, if your service has a
desiredCount of four tasks and a minimumHealthyPercent of 50%, the service
scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for
40 seconds after a task reaches a RUNNING state before the task is counted towards the
minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent
value is set to the default value and is used to define the lower limit on the number of the tasks in
the service that remain in the RUNNING state while the container instances are in the
DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or
EXTERNAL deployment types and is running tasks that use the Fargate launch type, the
minimum healthy percent value is not used, although it is returned when describing your service.
Copyright © 2022. All rights reserved.