Skip to content

aws.autoscaling_plans.describe_scaling_plans

Example SQL Queries

SELECT * FROM
aws.autoscaling_plans.describe_scaling_plans;

Description

Describes one or more of your scaling plans.

Table Definition

Column NameColumn Data Type
application_sources Input Column

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

STRUCT(
"cloud_formation_stack_arn" VARCHAR,
"tag_filters" STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
)[]
Show child fields
application_sources[]
Show child fields
application_sources[].cloud_formation_stack_arn

The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

application_sources[].tag_filters[]
Show child fields
application_sources[].tag_filters[].key

The tag key.

application_sources[].tag_filters[].values[]
scaling_plan_names Input Column

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

VARCHAR[]
Show child fields
scaling_plan_names[]
scaling_plan_version 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
application_source

A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

STRUCT(
"cloud_formation_stack_arn" VARCHAR,
"tag_filters" STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
)
Show child fields
application_source.cloud_formation_stack_arn

The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

application_source.tag_filters[]
Show child fields
application_source.tag_filters[].key

The tag key.

application_source.tag_filters[].values[]
creation_time

The Unix time stamp when the scaling plan was created.

TIMESTAMP_S
scaling_instructions

The scaling instructions.

STRUCT(
"service_namespace" VARCHAR,
"resource_id" VARCHAR,
"scalable_dimension" VARCHAR,
"min_capacity" BIGINT,
"max_capacity" BIGINT,
"target_tracking_configurations" 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
)[],
"predefined_load_metric_specification" STRUCT(
"predefined_load_metric_type" VARCHAR,
"resource_label" VARCHAR
),
"customized_load_metric_specification" STRUCT(
"metric_name" VARCHAR,
"namespace" VARCHAR,
"dimensions" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[],
"statistic" VARCHAR,
"unit" VARCHAR
),
"scheduled_action_buffer_time" BIGINT,
"predictive_scaling_max_capacity_behavior" VARCHAR,
"predictive_scaling_max_capacity_buffer" BIGINT,
"predictive_scaling_mode" VARCHAR,
"scaling_policy_update_behavior" VARCHAR,
"disable_dynamic_scaling" BOOLEAN
)[]
Show child fields
scaling_instructions[]
Show child fields
scaling_instructions[].customized_load_metric_specification

The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

Show child fields
scaling_instructions[].customized_load_metric_specification.dimensions[]
Show child fields
scaling_instructions[].customized_load_metric_specification.dimensions[].name

The name of the dimension.

scaling_instructions[].customized_load_metric_specification.dimensions[].value

The value of the dimension.

scaling_instructions[].customized_load_metric_specification.metric_name

The name of the metric.

scaling_instructions[].customized_load_metric_specification.namespace

The namespace of the metric.

scaling_instructions[].customized_load_metric_specification.statistic

The statistic of the metric. The only valid value is Sum.

scaling_instructions[].customized_load_metric_specification.unit

The unit of the metric.

scaling_instructions[].disable_dynamic_scaling

Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

The default is enabled (false).

scaling_instructions[].max_capacity

The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

scaling_instructions[].min_capacity

The minimum capacity of the resource.

scaling_instructions[].predefined_load_metric_specification

The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

Show child fields
scaling_instructions[].predefined_load_metric_specification.predefined_load_metric_type

The metric type.

scaling_instructions[].predefined_load_metric_specification.resource_label

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

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_instructions[].predictive_scaling_max_capacity_behavior

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

The following are possible values:

  • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

  • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

Only valid when configuring predictive scaling.

scaling_instructions[].predictive_scaling_max_capacity_buffer

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

The range is 1-100.

scaling_instructions[].predictive_scaling_mode

The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

scaling_instructions[].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.

scaling_instructions[].scalable_dimension

The scalable dimension associated with 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.

scaling_instructions[].scaling_policy_update_behavior

Controls whether a resource's externally created scaling policies are kept or replaced.

The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

Only valid when configuring dynamic scaling.

Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

scaling_instructions[].scheduled_action_buffer_time

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

Only valid when configuring predictive scaling.

scaling_instructions[].service_namespace

The namespace of the AWS service.

scaling_instructions[].target_tracking_configurations[]
Show child fields
scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification

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

Show child fields
scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.dimensions[]
Show child fields
scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.dimensions[].name

The name of the dimension.

scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.dimensions[].value

The value of the dimension.

scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.metric_name

The name of the metric.

scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.namespace

The namespace of the metric.

scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.statistic

The statistic of the metric.

scaling_instructions[].target_tracking_configurations[].customized_scaling_metric_specification.unit

The unit of the metric.

scaling_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].predefined_scaling_metric_specification

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

Show child fields
scaling_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].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_instructions[].target_tracking_configurations[].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_plan_name

The name of the scaling plan.

VARCHAR
status_code

The status of the scaling plan.

  • Active - The scaling plan is active.

  • ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

  • CreationInProgress - The scaling plan is being created.

  • CreationFailed - The scaling plan could not be created.

  • DeletionInProgress - The scaling plan is being deleted.

  • DeletionFailed - The scaling plan could not be deleted.

  • UpdateInProgress - The scaling plan is being updated.

  • UpdateFailed - The scaling plan could not be updated.

VARCHAR
status_message

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

VARCHAR
status_start_time

The Unix time stamp when the scaling plan entered the current status.

TIMESTAMP_S