Class: Aws::AutoScalingPlans::Types::PredefinedLoadMetricSpecification

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-autoscalingplans/types.rb

Overview

Represents a predefined metric that can be used for predictive 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*.

[1]: docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#predefined_load_metric_typeString

The metric type.

Returns:

  • (String)


588
589
590
591
592
593
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 588

class PredefinedLoadMetricSpecification < Struct.new(
  :predefined_load_metric_type,
  :resource_label)
  SENSITIVE = []
  include Aws::Structure
end

#resource_labelString

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/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:

  • app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN

  • targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; 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][1

API operation. To find the ARN for the

target group, use the [DescribeTargetGroups] API operation.

[1]: docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html [2]: docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html

Returns:

  • (String)


588
589
590
591
592
593
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 588

class PredefinedLoadMetricSpecification < Struct.new(
  :predefined_load_metric_type,
  :resource_label)
  SENSITIVE = []
  include Aws::Structure
end