AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::AutoScalingPlans::ScalingPlan PredefinedLoadMetricSpecification

PredefinedLoadMetricSpecification is a subproperty of ScalingInstruction that specifies a predefined load metric for predictive scaling to use with AWS Auto Scaling.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "PredefinedLoadMetricType" : String, "ResourceLabel" : String }

Properties

PredefinedLoadMetricType

The metric type.

Required: Yes

Type: String

Allowed Values: ALBTargetGroupRequestCount | ASGTotalCPUUtilization | ASGTotalNetworkIn | ASGTotalNetworkOut

Update requires: No interruption

ResourceLabel

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.

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.

Required: Conditional

Type: String

Minimum: 1

Maximum: 1023

Update requires: No interruption

See Also

On this page: