Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AutoScaling.Types.PredefinedMetricSpecification

Description

Synopsis

Documentation

data PredefinedMetricSpecification Source #

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

See: newPredefinedMetricSpecification smart constructor.

Constructors

PredefinedMetricSpecification'

Fields

resourceLabel :: Maybe Text
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 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 following predefined metrics are available:
- ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
- ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
- ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
- ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Instances

Instances details

Eq PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods (==) :: PredefinedMetricSpecification -> PredefinedMetricSpecification -> Bool # (/=) :: PredefinedMetricSpecification -> PredefinedMetricSpecification -> Bool #
Read PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods readsPrec :: Int -> ReadS PredefinedMetricSpecification # readList :: ReadS [PredefinedMetricSpecification] # readPrec :: ReadPrec PredefinedMetricSpecification # readListPrec :: ReadPrec [PredefinedMetricSpecification] #
Show PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods showsPrec :: Int -> PredefinedMetricSpecification -> ShowS # show :: PredefinedMetricSpecification -> String # showList :: [PredefinedMetricSpecification] -> ShowS #
Generic PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Associated Types type Rep PredefinedMetricSpecification :: Type -> Type # Methods from :: PredefinedMetricSpecification -> Rep PredefinedMetricSpecification x # to :: Rep PredefinedMetricSpecification x -> PredefinedMetricSpecification #
NFData PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods rnf :: PredefinedMetricSpecification -> () #
Hashable PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods hashWithSalt :: Int -> PredefinedMetricSpecification -> Int # hash :: PredefinedMetricSpecification -> Int #
ToQuery PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods toQuery :: PredefinedMetricSpecification -> QueryString #
FromXML PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification Methods parseXML :: [Node] -> Either String PredefinedMetricSpecification #
type Rep PredefinedMetricSpecification Source #
Instance details Defined in Amazonka.AutoScaling.Types.PredefinedMetricSpecification type Rep PredefinedMetricSpecification = D1 ('MetaData "PredefinedMetricSpecification" "Amazonka.AutoScaling.Types.PredefinedMetricSpecification" "libZSservicesZSamazonka-autoscalingZSamazonka-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 #

Arguments

:: MetricType	`$sel:predefinedMetricType:PredefinedMetricSpecification'`
-> PredefinedMetricSpecification

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 - A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 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 following predefined metrics are available:

ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 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 following predefined metrics are available:

ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.