Package software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.PredefinedMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.PredefinedMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(Stable)
public static interface CfnScalingPolicy.PredefinedMetricSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Contains predefined metric specification information for a target tracking scaling policy for Amazon EC2 Auto Scaling.

PredefinedMetricSpecification is a property of the AWS::AutoScaling::ScalingPolicy TargetTrackingConfiguration property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 PredefinedMetricSpecificationProperty predefinedMetricSpecificationProperty = PredefinedMetricSpecificationProperty.builder()
         .predefinedMetricType("predefinedMetricType")
         // the properties below are optional
         .resourceLabel("resourceLabel")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder	A builder for CfnScalingPolicy.PredefinedMetricSpecificationProperty
static final class	CfnScalingPolicy.PredefinedMetricSpecificationProperty.Jsii$Proxy	An implementation for CfnScalingPolicy.PredefinedMetricSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder	builder()
String	getPredefinedMetricType()	The metric type.
default String	getResourceLabel()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPredefinedMetricType

@Stability(Stable)
@NotNull
String getPredefinedMetricType()

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 - Average Application Load Balancer request count per target for your Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype

getResourceLabel

@Stability(Stable)
@Nullable
default String getResourceLabel()

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/invalid input: '<'load-balancer-name>/invalid input: '<'load-balancer-id> is the final portion of the load balancer ARN
• targetgroup/invalid input: '<'target-group-name>/invalid input: '<'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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel

builder

@Stability(Stable)
static CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder builder()

Returns:

a CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder of CfnScalingPolicy.PredefinedMetricSpecificationProperty