AWS cli: CodeDeploy get-deployment-group: ec2DeploymentOptions output field
Summary
Documents the new ec2DeploymentOptions structure (autoScalingGroupProcessesToSuspend) in the get-deployment-group output, describing the Auto Scaling processes CodeDeploy suspends during in-place deployments, the required service-role IAM permissions, and the risk of processes remaining suspended after a failed deployment. Also bumps the CLI version footer from 2.38.1 to 2.38.2.
Security assessment
This mirrors the create-deployment change in the read API output reference, restating the IAM permission requirement for the deployment group service role and the operational/availability caveat about suspended Auto Scaling processes. It is security-adjacent documentation of permissions and configuration impact, not a fix for a specific vulnerability.
Evidence
+>>> 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.
Diff
diff --git a/cli/latest/reference/deploy/get-deployment-group.md b/cli/latest/reference/deploy/get-deployment-group.md index 1379f70..7de60a5 100644 --- a//cli/latest/reference/deploy/get-deployment-group.md +++ b//cli/latest/reference/deploy/get-deployment-group.md @@ -15 +15 @@ - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) » @@ -989,0 +990,45 @@ deploymentGroupInfo -> (structure) +> +> ec2DeploymentOptions -> (structure) +> +>> Options that control how CodeDeploy manages Amazon EC2 Auto Scaling groups during a deployment. +>> +>> autoScalingGroupProcessesToSuspend -> (list) +>> +>>> The Amazon EC2 Auto Scaling processes to suspend during the deployment. 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 on the EC2/On-premises compute platform. If the list is empty, or if the deployment does not target instances in an Auto Scaling group, no processes are suspended. +>>> +>>> 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. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `4` +>>> + +>>> +>>> (string) +>>> +>>>> An Amazon EC2 Auto Scaling process that CodeDeploy can suspend during an in-place deployment. Valid values are `Terminate` , `AZRebalance` , `InstanceRefresh` , and `ScheduledActions` . +>>>> +>>>> Possible values: +>>>> +>>>> * `Terminate` +>>>> * `AZRebalance` +>>>> * `InstanceRefresh` +>>>> * `ScheduledActions` +>>>> + +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `255` +>>>> + @@ -1007 +1052 @@ deploymentGroupInfo -> (structure) - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) »