warm_pools

Creates, updates, deletes, gets or lists a warm_pools resource.

Overview

Name	warm_pools
Type	Resource
Id	aws.autoscaling.warm_pools

Fields

The following fields are returned by SELECT queries:

describe_warm_pool

Name	Datatype	Description
availability_zone	string	The Availability Zone in which the instance is running.
availability_zone_id	string	The Availability Zone ID where the instance was launched.
health_status	string	The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
image_id	string	The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. This value reflects the most recent AMI applied to the instance, including updates made through root volume replacement operations. This field appears for: Instances with root volume replacements through Instance Refresh Instances launched with AMI overrides This field won't appear for: Existing instances launched from Launch Templates without overrides Existing instances that didn’t have their root volume replaced through Instance Refresh
instance_id	string	The ID of the instance.
instance_type	string	The instance type of the EC2 instance.
launch_configuration_name	string	The launch configuration associated with the instance.
launch_template	string	The launch template for the instance.
lifecycle_state	string	A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.
protected_from_scale_in	boolean	Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
weighted_capacity	string	The number of capacity units contributed by the instance based on its instance type. Valid Range: Minimum value of 1. Maximum value of 999.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_warm_pool	select	AutoScalingGroupName, region	MaxRecords, NextToken	Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
put_warm_pool	replace	AutoScalingGroupName, region	MaxGroupPreparedCapacity, MinSize, PoolState, InstanceReusePolicy	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 DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
delete_warm_pool	delete	AutoScalingGroupName, region	ForceDelete	Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
AutoScalingGroupName	string	The name of the Auto Scaling group.
region	string	AWS region (default: us-east-1)
ForceDelete	boolean	Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances.
InstanceReusePolicy	object	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	integer	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.
MaxRecords	integer	The maximum number of instances to return with this call. The maximum value is 50.
MinSize	integer	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.
NextToken	string	The token for the next set of instances to return. (You received this token from a previous call.)
PoolState	string	Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

SELECT examples

describe_warm_pool

Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

SELECT
availability_zone,
availability_zone_id,
health_status,
image_id,
instance_id,
instance_type,
launch_configuration_name,
launch_template,
lifecycle_state,
protected_from_scale_in,
weighted_capacity
FROM aws.autoscaling.warm_pools
WHERE AutoScalingGroupName = '{{ AutoScalingGroupName }}' -- required
AND region = '{{ region }}' -- required
AND MaxRecords = '{{ MaxRecords }}'
AND NextToken = '{{ NextToken }}'
;

REPLACE examples

put_warm_pool

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 DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

REPLACE aws.autoscaling.warm_pools
SET 
-- No updatable properties
WHERE 
AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND region = '{{ region }}' --required
AND MaxGroupPreparedCapacity = '{{ MaxGroupPreparedCapacity}}'
AND MinSize = '{{ MinSize}}'
AND PoolState = '{{ PoolState}}'
AND InstanceReusePolicy = '{{ InstanceReusePolicy}}';

DELETE examples

delete_warm_pool

Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

DELETE FROM aws.autoscaling.warm_pools
WHERE AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND region = '{{ region }}' --required
AND ForceDelete = '{{ ForceDelete }}'
;