libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling
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.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Description

 
Synopsis

Documentation

data PredefinedMetricSpecification Source #

Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building dashboards with CloudWatch in the Application Auto Scaling User Guide.

See: newPredefinedMetricSpecification smart constructor.

Constructors

PredefinedMetricSpecification' 

Fields

  • resourceLabel :: Maybe Text

    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 attached to the 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 of the resource label is:

    app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

    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.

    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.

  • predefinedMetricType :: MetricType

    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and ECS services.

Instances

Instances details
Eq PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Read PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Show PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Generic PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Associated Types

type Rep PredefinedMetricSpecification :: Type -> Type #

NFData PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

Hashable PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

ToJSON PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

FromJSON PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

type Rep PredefinedMetricSpecification Source # 
Instance details

Defined in Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification

type Rep PredefinedMetricSpecification = D1 ('MetaData "PredefinedMetricSpecification" "Amazonka.ApplicationAutoScaling.Types.PredefinedMetricSpecification" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "PredefinedMetricSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "predefinedMetricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricType)))

newPredefinedMetricSpecification Source #

Create a value of PredefinedMetricSpecification 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:PredefinedMetricSpecification', predefinedMetricSpecification_resourceLabel - 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 attached to the 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 of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

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.

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:predefinedMetricType:PredefinedMetricSpecification', predefinedMetricSpecification_predefinedMetricType - The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and ECS services.

predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #

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 attached to the 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 of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

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.

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.

predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType Source #

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and ECS services.