libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Description

 
Synopsis

Documentation

data PredefinedLoadMetricSpecification Source #

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.

See: newPredefinedLoadMetricSpecification smart constructor.

Constructors

PredefinedLoadMetricSpecification' 

Fields

  • resourceLabel :: Maybe Text

    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.

  • predefinedLoadMetricType :: LoadMetricType

    The metric type.

Instances

Instances details
Eq PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Read PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Show PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Generic PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Associated Types

type Rep PredefinedLoadMetricSpecification :: Type -> Type #

NFData PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

Hashable PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

ToJSON PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

FromJSON PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

type Rep PredefinedLoadMetricSpecification Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification

type Rep PredefinedLoadMetricSpecification = D1 ('MetaData "PredefinedLoadMetricSpecification" "Amazonka.AutoScalingPlans.Types.PredefinedLoadMetricSpecification" "libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans" 'False) (C1 ('MetaCons "PredefinedLoadMetricSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "predefinedLoadMetricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LoadMetricType)))

newPredefinedLoadMetricSpecification Source #

Create a value of PredefinedLoadMetricSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceLabel:PredefinedLoadMetricSpecification', predefinedLoadMetricSpecification_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.

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.

$sel:predefinedLoadMetricType:PredefinedLoadMetricSpecification', predefinedLoadMetricSpecification_predefinedLoadMetricType - The metric type.

predefinedLoadMetricSpecification_resourceLabel :: Lens' PredefinedLoadMetricSpecification (Maybe Text) Source #

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.