|
907 | 907 | {"shape":"ResourceContentionFault"},
|
908 | 908 | {"shape":"InstanceRefreshInProgressFault"}
|
909 | 909 | ],
|
910 |
| - "documentation":"<p>Starts a new instance refresh operation, which triggers a rolling replacement of previously launched instances in the Auto Scaling group with a new group of instances.</p> <p>This operation is part of the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">instance refresh feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.</p> <p>If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an instance refresh operation in progress, use the <a>CancelInstanceRefresh</a> API. </p>" |
| 910 | + "documentation":"<p>Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.</p> <p>This operation is part of the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">instance refresh feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group. </p> <p>If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an instance refresh operation in progress, use the <a>CancelInstanceRefresh</a> API. </p>" |
911 | 911 | },
|
912 | 912 | "SuspendProcesses":{
|
913 | 913 | "name":"SuspendProcesses",
|
|
2340 | 2340 | }
|
2341 | 2341 | }
|
2342 | 2342 | },
|
| 2343 | + "DesiredConfiguration":{ |
| 2344 | + "type":"structure", |
| 2345 | + "members":{ |
| 2346 | + "LaunchTemplate":{"shape":"LaunchTemplateSpecification"}, |
| 2347 | + "MixedInstancesPolicy":{"shape":"MixedInstancesPolicy"} |
| 2348 | + }, |
| 2349 | + "documentation":"<p>Describes the desired configuration for an instance refresh. </p> <p>If you specify a desired configuration, you must specify either a <code>LaunchTemplate</code> or a <code>MixedInstancesPolicy</code>. </p>" |
| 2350 | + }, |
2343 | 2351 | "DetachInstancesAnswer":{
|
2344 | 2352 | "type":"structure",
|
2345 | 2353 | "members":{
|
|
2818 | 2826 | "ProgressDetails":{
|
2819 | 2827 | "shape":"InstanceRefreshProgressDetails",
|
2820 | 2828 | "documentation":"<p>Additional progress details for an Auto Scaling group that has a warm pool.</p>"
|
| 2829 | + }, |
| 2830 | + "Preferences":{"shape":"RefreshPreferences"}, |
| 2831 | + "DesiredConfiguration":{ |
| 2832 | + "shape":"DesiredConfiguration", |
| 2833 | + "documentation":"<p>Describes the specific update you want to deploy.</p>" |
2821 | 2834 | }
|
2822 | 2835 | },
|
2823 | 2836 | "documentation":"<p>Describes an instance refresh for an Auto Scaling group. </p>"
|
|
2928 | 2941 | "documentation":"<p>The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value at its default (empty), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string (\"\") for the value.</p>"
|
2929 | 2942 | }
|
2930 | 2943 | },
|
2931 |
| - "documentation":"<p>Describes an instances distribution for an Auto Scaling group with a <a>MixedInstancesPolicy</a>.</p> <p>The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities.</p> <p>When you update <code>SpotAllocationStrategy</code>, <code>SpotInstancePools</code>, or <code>SpotMaxPrice</code>, this update action does not deploy any changes across the running Amazon EC2 instances in the group. Your existing Spot Instances continue to run as long as the maximum price for those instances is higher than the current Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>" |
| 2944 | + "documentation":"<p>Describes an instances distribution for an Auto Scaling group with a <a>MixedInstancesPolicy</a>.</p> <p>The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities.</p> <p>When you modify <code>SpotAllocationStrategy</code>, <code>SpotInstancePools</code>, or <code>SpotMaxPrice</code> in the <a>UpdateAutoScalingGroup</a> API call, this update action does not deploy any changes across the running Amazon EC2 instances in the group. Your existing Spot Instances continue to run as long as the maximum price for those instances is higher than the current Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>" |
2932 | 2945 | },
|
2933 | 2946 | "InstancesToUpdate":{
|
2934 | 2947 | "type":"integer",
|
|
3108 | 3121 | "documentation":"<p>Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when it launches an instance. </p>"
|
3109 | 3122 | }
|
3110 | 3123 | },
|
3111 |
| - "documentation":"<p>Describes a launch template and overrides. </p> <p>You specify these properties as part of a mixed instances policy. </p> <p>When you update the launch template or overrides, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>" |
| 3124 | + "documentation":"<p>Describes a launch template and overrides. </p> <p>You specify these properties as part of a mixed instances policy. </p> <p>When you update the launch template or overrides in the <a>UpdateAutoScalingGroup</a> API call, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>" |
3112 | 3125 | },
|
3113 | 3126 | "LaunchTemplateName":{
|
3114 | 3127 | "type":"string",
|
|
3150 | 3163 | "documentation":"<p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get the version number, use the Amazon EC2 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html\">DescribeLaunchTemplateVersions</a> API operation. New launch template versions can be created using the Amazon EC2 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html\">CreateLaunchTemplateVersion</a> API. If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.</p>"
|
3151 | 3164 | }
|
3152 | 3165 | },
|
3153 |
| - "documentation":"<p>Describes the Amazon EC2 launch template and the launch template version that can be used by an Auto Scaling group to configure Amazon EC2 instances.</p> <p>The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html\">Creating a launch template for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>" |
| 3166 | + "documentation":"<p>Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html\">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>" |
3154 | 3167 | },
|
3155 | 3168 | "LifecycleActionResult":{"type":"string"},
|
3156 | 3169 | "LifecycleActionToken":{
|
|
3464 | 3477 | "members":{
|
3465 | 3478 | "LaunchTemplate":{
|
3466 | 3479 | "shape":"LaunchTemplate",
|
3467 |
| - "documentation":"<p>Specifies the launch template to use and optionally the instance types (overrides) that are used to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when creating a mixed instances policy.</p>" |
| 3480 | + "documentation":"<p>Specifies the launch template to use and the instance types (overrides) that are used to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when creating a mixed instances policy.</p>" |
3468 | 3481 | },
|
3469 | 3482 | "InstancesDistribution":{
|
3470 | 3483 | "shape":"InstancesDistribution",
|
3471 | 3484 | "documentation":"<p>Specifies the instances distribution. If not provided, the value for each property in <code>InstancesDistribution</code> uses a default value.</p>"
|
3472 | 3485 | }
|
3473 | 3486 | },
|
3474 |
| - "documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level property instead of a launch configuration or launch template.</p>" |
| 3487 | + "documentation":"<p>Describes a mixed instances policy. A mixed instances policy contains the instance types Amazon EC2 Auto Scaling can launch, and other information Amazon EC2 Auto Scaling can use to launch instances to help you optimize your costs. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>" |
3475 | 3488 | },
|
3476 | 3489 | "MonitoringEnabled":{"type":"boolean"},
|
3477 | 3490 | "NoDevice":{"type":"boolean"},
|
|
4003 | 4016 | "members":{
|
4004 | 4017 | "MinHealthyPercentage":{
|
4005 | 4018 | "shape":"IntPercent",
|
4006 |
| - "documentation":"<p>The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue, as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is <code>90</code>. </p>" |
| 4019 | + "documentation":"<p>The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is <code>90</code>.</p> <p>Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time. </p>" |
4007 | 4020 | },
|
4008 | 4021 | "InstanceWarmup":{
|
4009 | 4022 | "shape":"RefreshInstanceWarmup",
|
|
4016 | 4029 | "CheckpointDelay":{
|
4017 | 4030 | "shape":"CheckpointDelay",
|
4018 | 4031 | "documentation":"<p>The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for <code>CheckpointPercentages</code>. If you specify a value for <code>CheckpointPercentages</code> and not for <code>CheckpointDelay</code>, the <code>CheckpointDelay</code> defaults to <code>3600</code> (1 hour). </p>"
|
| 4032 | + }, |
| 4033 | + "SkipMatching":{ |
| 4034 | + "shape":"SkipMatching", |
| 4035 | + "documentation":"<p>A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is <code>false</code>.</p>" |
4019 | 4036 | }
|
4020 | 4037 | },
|
4021 |
| - "documentation":"<p>Describes information used to start an instance refresh. </p> <p>All properties are optional. However, if you specify a value for <code>CheckpointDelay</code>, you must also provide a value for <code>CheckpointPercentages</code>. </p>" |
| 4038 | + "documentation":"<p>Describes the preferences for an instance refresh.</p>" |
4022 | 4039 | },
|
4023 | 4040 | "RefreshStrategy":{
|
4024 | 4041 | "type":"string",
|
|
4386 | 4403 | },
|
4387 | 4404 | "ShouldDecrementDesiredCapacity":{"type":"boolean"},
|
4388 | 4405 | "ShouldRespectGracePeriod":{"type":"boolean"},
|
| 4406 | + "SkipMatching":{"type":"boolean"}, |
4389 | 4407 | "SpotInstancePools":{"type":"integer"},
|
4390 | 4408 | "SpotPrice":{
|
4391 | 4409 | "type":"string",
|
|
4411 | 4429 | },
|
4412 | 4430 | "Strategy":{
|
4413 | 4431 | "shape":"RefreshStrategy",
|
4414 |
| - "documentation":"<p>The strategy to use for the instance refresh. The only valid value is <code>Rolling</code>.</p> <p>A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration. </p>" |
| 4432 | + "documentation":"<p>The strategy to use for the instance refresh. The only valid value is <code>Rolling</code>.</p> <p>A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration. </p>" |
| 4433 | + }, |
| 4434 | + "DesiredConfiguration":{ |
| 4435 | + "shape":"DesiredConfiguration", |
| 4436 | + "documentation":"<p>The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.</p> <p>Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration. </p> <note> <p>When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the <code>SkipMatching</code> property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates. </p> </note>" |
4415 | 4437 | },
|
4416 | 4438 | "Preferences":{
|
4417 | 4439 | "shape":"RefreshPreferences",
|
4418 |
| - "documentation":"<p>Set of preferences associated with the instance refresh request.</p> <p>If not provided, the default values are used. For <code>MinHealthyPercentage</code>, the default value is <code>90</code>. For <code>InstanceWarmup</code>, the default is to use the value specified for the health check grace period for the Auto Scaling group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html\">RefreshPreferences</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p>" |
| 4440 | + "documentation":"<p>Set of preferences associated with the instance refresh request. If not provided, the default values are used.</p>" |
4419 | 4441 | }
|
4420 | 4442 | }
|
4421 | 4443 | },
|
|
0 commit comments