Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Documentation

data PredefinedScalingMetricSpecification

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

See: newPredefinedScalingMetricSpecification smart constructor.

Constructors

PredefinedScalingMetricSpecification'

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 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.

• predefinedScalingMetricType :: ScalingMetricType

  The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Instances

FromJSON PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

parseJSON :: Value -> Parser PredefinedScalingMetricSpecification

parseJSONList :: Value -> Parser [PredefinedScalingMetricSpecification]

ToJSON PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

toJSON :: PredefinedScalingMetricSpecification -> Value

toEncoding :: PredefinedScalingMetricSpecification -> Encoding

toJSONList :: [PredefinedScalingMetricSpecification] -> Value

toEncodingList :: [PredefinedScalingMetricSpecification] -> Encoding

Generic PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Associated Types

type Rep PredefinedScalingMetricSpecification :: Type -> Type

Methods

from :: PredefinedScalingMetricSpecification -> Rep PredefinedScalingMetricSpecification x

to :: Rep PredefinedScalingMetricSpecification x -> PredefinedScalingMetricSpecification

Read PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

readsPrec :: Int -> ReadS PredefinedScalingMetricSpecification

readList :: ReadS [PredefinedScalingMetricSpecification]

readPrec :: ReadPrec PredefinedScalingMetricSpecification

readListPrec :: ReadPrec [PredefinedScalingMetricSpecification]

Show PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

showsPrec :: Int -> PredefinedScalingMetricSpecification -> ShowS

show :: PredefinedScalingMetricSpecification -> String

showList :: [PredefinedScalingMetricSpecification] -> ShowS

NFData PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

rnf :: PredefinedScalingMetricSpecification -> ()

Eq PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

(==) :: PredefinedScalingMetricSpecification -> PredefinedScalingMetricSpecification -> Bool

(/=) :: PredefinedScalingMetricSpecification -> PredefinedScalingMetricSpecification -> Bool

Hashable PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

Methods

hashWithSalt :: Int -> PredefinedScalingMetricSpecification -> Int

hash :: PredefinedScalingMetricSpecification -> Int

type Rep PredefinedScalingMetricSpecification

Defined in Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification

type Rep PredefinedScalingMetricSpecification = D1 ('MetaData "PredefinedScalingMetricSpecification" "Amazonka.AutoScalingPlans.Types.PredefinedScalingMetricSpecification" "amazonka-autoscaling-plans-2.0-1ffFjJ7hnaH6GMb2VoWJfu" 'False) (C1 ('MetaCons "PredefinedScalingMetricSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "predefinedScalingMetricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalingMetricType)))

newPredefinedScalingMetricSpecification

Arguments

:: ScalingMetricType

$sel:predefinedScalingMetricType:PredefinedScalingMetricSpecification'

-> PredefinedScalingMetricSpecification

Create a value of PredefinedScalingMetricSpecification 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:PredefinedScalingMetricSpecification', predefinedScalingMetricSpecification_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 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.

$sel:predefinedScalingMetricType:PredefinedScalingMetricSpecification', predefinedScalingMetricSpecification_predefinedScalingMetricType - The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

predefinedScalingMetricSpecification_resourceLabel :: Lens' PredefinedScalingMetricSpecification (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 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.

predefinedScalingMetricSpecification_predefinedScalingMetricType :: Lens' PredefinedScalingMetricSpecification ScalingMetricType

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.