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	awscc.autoscaling.warm_pools

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
auto_scaling_group_name	string
region	string	AWS region.

For more information, see AWS::AutoScaling::WarmPool.

Methods

Name	Resource	Accessible by	Required Params
create_resource	warm_pools	INSERT	AutoScalingGroupName, region
delete_resource	warm_pools	DELETE	Identifier, region
update_resource	warm_pools	UPDATE	Identifier, PatchDocument, region
list_resources	warm_pools_list_only	SELECT	region
get_resource	warm_pools	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.autoscaling.warm_pools
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ auto_scaling_group_name }}';

list (identifiers only)

Lists all warm_pools in a region.

SELECT
  region,
  auto_scaling_group_name
FROM awscc.autoscaling.warm_pools_list_only
WHERE
  region = 'us-east-1';

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 awscc.autoscaling.warm_pools (
  AutoScalingGroupName,
  region
)
SELECT
  '{{ auto_scaling_group_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.autoscaling.warm_pools (
  AutoScalingGroupName,
  MaxGroupPreparedCapacity,
  MinSize,
  PoolState,
  InstanceReusePolicy,
  region
)
SELECT
  '{{ auto_scaling_group_name }}',
  '{{ max_group_prepared_capacity }}',
  '{{ min_size }}',
  '{{ pool_state }}',
  '{{ instance_reuse_policy }}',
  '{{ 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: auto_scaling_group_name
        value: '{{ auto_scaling_group_name }}'
      - name: max_group_prepared_capacity
        value: '{{ max_group_prepared_capacity }}'
      - name: min_size
        value: '{{ min_size }}'
      - name: pool_state
        value: '{{ pool_state }}'
      - name: instance_reuse_policy
        value:
          reuse_on_scale_in: '{{ reuse_on_scale_in }}'

UPDATE example

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

/*+ update */
UPDATE awscc.autoscaling.warm_pools
SET PatchDocument = string('{{ {
    "MaxGroupPreparedCapacity": max_group_prepared_capacity,
    "MinSize": min_size,
    "PoolState": pool_state,
    "InstanceReusePolicy": instance_reuse_policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ auto_scaling_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.autoscaling.warm_pools
WHERE
  Identifier = '{{ auto_scaling_group_name }}' 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

List

autoscaling:DescribeWarmPool