warm_pools

Creates, updates, deletes or gets a warm_pool resource or lists warm_pools in a region

Overview

Name	warm_pools
Type	Resource
Description	Resource schema for AWS::AutoScaling::WarmPool.
Id	aws.autoscaling.warm_pools

Fields

Name	Datatype	Description
auto_scaling_group_name	string
max_group_prepared_capacity	integer
min_size	integer
pool_state	string
instance_reuse_policy	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AutoScalingGroupName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual warm_pool.

SELECT
region,
auto_scaling_group_name,
max_group_prepared_capacity,
min_size,
pool_state,
instance_reuse_policy
FROM aws.autoscaling.warm_pools
WHERE region = 'us-east-1' AND data__Identifier = '<AutoScalingGroupName>';

INSERT example

Use the following StackQL query and manifest file to create a new warm_pool resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.autoscaling.warm_pools (
 AutoScalingGroupName,
 region
)
SELECT 
'{{ AutoScalingGroupName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.autoscaling.warm_pools (
 AutoScalingGroupName,
 MaxGroupPreparedCapacity,
 MinSize,
 PoolState,
 InstanceReusePolicy,
 region
)
SELECT 
 '{{ AutoScalingGroupName }}',
 '{{ MaxGroupPreparedCapacity }}',
 '{{ MinSize }}',
 '{{ PoolState }}',
 '{{ InstanceReusePolicy }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: warm_pool
    props:
      - name: AutoScalingGroupName
        value: '{{ AutoScalingGroupName }}'
      - name: MaxGroupPreparedCapacity
        value: '{{ MaxGroupPreparedCapacity }}'
      - name: MinSize
        value: '{{ MinSize }}'
      - name: PoolState
        value: '{{ PoolState }}'
      - name: InstanceReusePolicy
        value:
          ReuseOnScaleIn: '{{ ReuseOnScaleIn }}'

DELETE example

/*+ delete */
DELETE FROM aws.autoscaling.warm_pools
WHERE data__Identifier = '<AutoScalingGroupName>'
AND region = 'us-east-1';

Permissions

To operate on the warm_pools resource, the following permissions are required:

Create

autoscaling:PutWarmPool,
autoscaling:DescribeWarmPool,
autoscaling:DescribeAutoScalingGroups

Delete

autoscaling:DeleteWarmPool,
autoscaling:DescribeWarmPool

Read

autoscaling:DescribeWarmPool

Update

autoscaling:PutWarmPool,
autoscaling:DescribeWarmPool,
autoscaling:DescribeAutoScalingGroups