AWS cli: CodeDeploy get-deployment: document ec2DeploymentOptions output field
Summary
Adds reference documentation for the new ec2DeploymentOptions structure in the get-deployment output, including the autoScalingGroupProcessesToSuspend list (Terminate, AZRebalance, InstanceRefresh, ScheduledActions), its constraints, and notes on required IAM permissions and the risk of leaving Auto Scaling processes suspended. Also bumps the CLI version footer from 2.38.1 to 2.38.2.
Security assessment
This is API reference documentation for a new CodeDeploy deployment option. It mentions the IAM permissions the service role needs and warns that suspended Terminate processes stop Auto Scaling from replacing unhealthy instances, but it documents operational/availability behavior rather than fixing a vulnerability or documenting a security control.
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.md b/cli/latest/reference/deploy/get-deployment.md index 4d53591..c7124fc 100644 --- a//cli/latest/reference/deploy/get-deployment.md +++ b//cli/latest/reference/deploy/get-deployment.md @@ -15 +15 @@ - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) » @@ -1123,0 +1124,45 @@ deploymentInfo -> (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` +>>>> + @@ -1135 +1180 @@ deploymentInfo -> (structure) - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) »