AWS cli: Document ec2DeploymentOptions Auto Scaling process suspension in CodeDeploy
Summary
Adds documentation for the ec2DeploymentOptions structure returned by batch-get-deployment-groups, describing autoScalingGroupProcessesToSuspend (Terminate, AZRebalance, InstanceRefresh, ScheduledActions), the service-role permissions required, and a note that suspended Terminate prevents Auto Scaling from replacing unhealthy instances. Also bumps the CLI version footer to 2.38.2.
Security assessment
The change documents a new deployment option and its operational/availability caveats, including the IAM permissions the CodeDeploy service role needs on Auto Scaling groups; this is hardening/operational guidance with security-adjacent IAM implications, 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/batch-get-deployment-groups.md b/cli/latest/reference/deploy/batch-get-deployment-groups.md index 0ee1f54..ce468e8 100644 --- a//cli/latest/reference/deploy/batch-get-deployment-groups.md +++ b//cli/latest/reference/deploy/batch-get-deployment-groups.md @@ -15 +15 @@ - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) » @@ -1057,0 +1058,45 @@ deploymentGroupsInfo -> (list) +>> +>> 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` +>>>>> + @@ -1079 +1124 @@ errorMessage -> (string) - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) »