View a markdown version of this page

AWS::CodeDeploy::DeploymentGroup Ec2DeploymentOptions - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::CodeDeploy::DeploymentGroup Ec2DeploymentOptions

Options that control how AWS CodeDeploy manages Amazon EC2 resources during a deployment.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "AutoScalingGroupProcessesToSuspend" : [ String, ... ] }

Properties

AutoScalingGroupProcessesToSuspend

The Amazon EC2 Auto Scaling processes to suspend during the deployment. AWS CodeDeploy suspends these processes before it deploys to instances in an Auto Scaling group, and resumes them when the deployment succeeds, fails, or is stopped. Valid values are Terminate, AZRebalance, InstanceRefresh, and ScheduledActions.

This parameter applies only to in-place deployments to Amazon EC2 instances in Auto Scaling groups. If the list is empty, no processes are suspended. If the list isn't empty and the deployment group doesn't use in-place deployments or doesn't include an Auto Scaling group, the request fails with InvalidAutoScalingGroupProcessToSuspendException.

The service role for the deployment group must have permission to call autoscaling:SuspendProcesses and autoscaling:ResumeProcesses on the target Auto Scaling groups. If the processes cannot be suspended, the deployment fails before any instance is updated.

If you suspend ScheduledActions, scheduled actions with a start time during the deployment are skipped and do not run after the process resumes.

Note

If CodeDeploy cannot resume the processes, the deployment fails and the processes stay suspended until you resume them with the Auto Scaling ResumeProcesses action. While Terminate is suspended, Auto Scaling does not replace unhealthy instances. If you suspend Terminate, configure a trigger that notifies you when a deployment fails.

Required: No

Type: Array of String

Minimum: 1

Update requires: No interruption