scaling_plan_resources

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

Overview

Name	scaling_plan_resources
Type	Resource
Id	aws.autoscaling_plans.scaling_plan_resources

Fields

The following fields are returned by SELECT queries:

describe_scaling_plan_resources

Name	Datatype	Description
resource_id	string	The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
scalable_dimension	string	The scalable dimension for the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. (autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits)
scaling_plan_name	string	The name of the scaling plan. (pattern: <code>[\p{Print}&&[^|:/]]+</code>)
scaling_plan_version	integer (int64)	The version number of the scaling plan.
scaling_policies	array	The scaling policies.
scaling_status_code	string	The scaling status of the resource. Active - The scaling configuration is active. Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information. (Inactive, PartiallyActive, Active)
scaling_status_message	string	A simple message about the current scaling status of the resource. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
service_namespace	string	The namespace of the AWS service. (autoscaling, ecs, ec2, rds, dynamodb)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_scaling_plan_resources	select	region		Describes the scalable resources in the specified scaling plan.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_scaling_plan_resources

Describes the scalable resources in the specified scaling plan.

SELECT
resource_id,
scalable_dimension,
scaling_plan_name,
scaling_plan_version,
scaling_policies,
scaling_status_code,
scaling_status_message,
service_namespace
FROM aws.autoscaling_plans.scaling_plan_resources
WHERE region = '{{ region }}' -- required
;