Put Warm Pool

autoscaling_put_warm_pool

R Documentation

Creates or updates a warm pool for the specified Auto Scaling group¶

Description¶

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.

This operation must be called from the Region in which the Auto Scaling group was created.

You can view the instances in the warm pool using the describe_warm_pool API call. If you are no longer using a warm pool, you can delete it by calling the delete_warm_pool API.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Usage¶

autoscaling_put_warm_pool(AutoScalingGroupName,
  MaxGroupPreparedCapacity, MinSize, PoolState, InstanceReusePolicy)

Arguments¶

AutoScalingGroupName

[required] The name of the Auto Scaling group.

MaxGroupPreparedCapacity

Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

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

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

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.

Value¶

An empty list.

Request syntax¶

svc$put_warm_pool(
  AutoScalingGroupName = "string",
  MaxGroupPreparedCapacity = 123,
  MinSize = 123,
  PoolState = "Stopped"|"Running"|"Hibernated",
  InstanceReusePolicy = list(
    ReuseOnScaleIn = TRUE|FALSE
  )
)

Examples¶

## Not run: 
# This example creates a warm pool for the specified Auto Scaling group.
svc$put_warm_pool(
  AutoScalingGroupName = "my-auto-scaling-group",
  InstanceReusePolicy = list(
    ReuseOnScaleIn = TRUE
  ),
  MinSize = 30L,
  PoolState = "Hibernated"
)

## End(Not run)