AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DeploymentConfiguration

import "github.com/aws/aws-sdk-go/service/ecs"

type DeploymentConfiguration struct { MaximumPercent *int64 `locationName:"maximumPercent" type:"integer"` MinimumHealthyPercent *int64 `locationName:"minimumHealthyPercent" type:"integer"` }

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

MaximumPercent

Type: *int64

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent 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 value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) deployment type 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.

MinimumHealthyPercent

Type: *int64

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and 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 the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

Method

GoString

func (s DeploymentConfiguration) GoString() string

GoString returns the string representation

SetMaximumPercent

func (s *DeploymentConfiguration) SetMaximumPercent(v int64) *DeploymentConfiguration

SetMaximumPercent sets the MaximumPercent field's value.

SetMinimumHealthyPercent

func (s *DeploymentConfiguration) SetMinimumHealthyPercent(v int64) *DeploymentConfiguration

SetMinimumHealthyPercent sets the MinimumHealthyPercent field's value.

String

func (s DeploymentConfiguration) String() string

String returns the string representation

On this page: