Skip to content

aws.autoscaling_plans.describe_scaling_plan_resources

Example SQL Queries

SELECT * FROM
aws.autoscaling_plans.describe_scaling_plan_resources
WHERE
"scaling_plan_name" = 'VALUE'
AND "scaling_plan_version" = 'VALUE';

Description

Describes the scalable resources in the specified scaling plan.

Table Definition

Column NameColumn Data Type
scaling_plan_name Required Input Column

The name of the scaling plan.

VARCHAR
scaling_plan_version Required Input Column

The version number of the scaling plan.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
resource_id

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.

VARCHAR
scalable_dimension

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.

VARCHAR
scaling_policies

The scaling policies.

STRUCT(
"policy_name" VARCHAR,
"policy_type" VARCHAR,
"target_tracking_configuration" STRUCT(
"predefined_scaling_metric_specification" STRUCT(
"predefined_scaling_metric_type" VARCHAR,
"resource_label" VARCHAR
),
"customized_scaling_metric_specification" STRUCT(
"metric_name" VARCHAR,
"namespace" VARCHAR,
"dimensions" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[],
"statistic" VARCHAR,
"unit" VARCHAR
),
"target_value" DOUBLE,
"disable_scale_in" BOOLEAN,
"scale_out_cooldown" BIGINT,
"scale_in_cooldown" BIGINT,
"estimated_instance_warmup" BIGINT
)
)[]
Show child fields
scaling_policies[]
Show child fields
scaling_policies[].policy_name

The name of the scaling policy.

scaling_policies[].policy_type

The type of scaling policy.

scaling_policies[].target_tracking_configuration

The target tracking scaling policy. Includes support for predefined or customized metrics.

Show child fields
scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification

A customized metric. You can specify either a predefined metric or a customized metric.

Show child fields
scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.dimensions[]
Show child fields
scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.dimensions[].name

The name of the dimension.

scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.dimensions[].value

The value of the dimension.

scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.metric_name

The name of the metric.

scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.namespace

The namespace of the metric.

scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.statistic

The statistic of the metric.

scaling_policies[].target_tracking_configuration.customized_scaling_metric_specification.unit

The unit of the metric.

scaling_policies[].target_tracking_configuration.disable_scale_in

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

The default value is false.

scaling_policies[].target_tracking_configuration.estimated_instance_warmup

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

scaling_policies[].target_tracking_configuration.predefined_scaling_metric_specification

A predefined metric. You can specify either a predefined metric or a customized metric.

Show child fields
scaling_policies[].target_tracking_configuration.predefined_scaling_metric_specification.predefined_scaling_metric_type

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

scaling_policies[].target_tracking_configuration.predefined_scaling_metric_specification.resource_label

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

scaling_policies[].target_tracking_configuration.scale_in_cooldown

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

scaling_policies[].target_tracking_configuration.scale_out_cooldown

The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

scaling_policies[].target_tracking_configuration.target_value

The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.

scaling_status_code

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.

VARCHAR
scaling_status_message

A simple message about the current scaling status of the resource.

VARCHAR
service_namespace

The namespace of the AWS service.

VARCHAR