Package software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

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

Contains metric pair information for the PredefinedMetricPairSpecification property of the AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification property type.

For more information, see Predictive scaling in the Amazon EC2 Auto Scaling User Guide .

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.*;
 PredictiveScalingPredefinedMetricPairProperty predictiveScalingPredefinedMetricPairProperty = PredictiveScalingPredefinedMetricPairProperty.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-predictivescalingpredefinedmetricpair.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty.Builder	builder()
String	getPredefinedMetricType()	Indicates which metrics to use.
default String	getResourceLabel()	A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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()

Indicates which metrics to use.

There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization , the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-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 total and 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-predictivescalingpredefinedmetricpair.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-resourcelabel

builder

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

Returns:

a CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty.Builder of CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty