AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PutWarmPool operation. Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z
public class PutWarmPoolRequest : AmazonAutoScalingRequest IAmazonWebServiceRequest
The PutWarmPoolRequest type exposes the following members
Name | Description | |
---|---|---|
PutWarmPoolRequest() |
Name | Type | Description | |
---|---|---|---|
AutoScalingGroupName | System.String |
Gets and sets the property AutoScalingGroupName. The name of the Auto Scaling group. |
|
InstanceReusePolicy | Amazon.AutoScaling.Model.InstanceReusePolicy |
Gets and sets the property InstanceReusePolicy. Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in. |
|
MaxGroupPreparedCapacity | System.Int32 |
Gets and sets the property MaxGroupPreparedCapacity.
Specifies the maximum number of instances that are allowed to be in the warm pool
or in any state except
If a value for
The size of the warm pool is dynamic. Only when
If the desired capacity of the Auto Scaling group is higher than the |
|
MinSize | System.Int32 |
Gets and sets the property MinSize. Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified. |
|
PoolState | Amazon.AutoScaling.WarmPoolState |
Gets and sets the property PoolState.
Sets the instance state to transition to after the lifecycle actions are complete.
Default is |
This example creates a warm pool for the specified Auto Scaling group.
var client = new AmazonAutoScalingClient(); var response = client.PutWarmPool(new PutWarmPoolRequest { AutoScalingGroupName = "my-auto-scaling-group", InstanceReusePolicy = new InstanceReusePolicy { ReuseOnScaleIn = true }, MinSize = 30, PoolState = "Hibernated" });
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5