Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.PredefinedLoadMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

@Stability(Stable)
public static interface CfnScalingPlan.PredefinedLoadMetricSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

PredefinedLoadMetricSpecification is a subproperty of ScalingInstruction that specifies a predefined load metric for predictive scaling to use with a scaling plan.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View scaling information for a resource in the Scaling Plans 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.autoscalingplans.*;
 PredefinedLoadMetricSpecificationProperty predefinedLoadMetricSpecificationProperty = PredefinedLoadMetricSpecificationProperty.builder()
         .predefinedLoadMetricType("predefinedLoadMetricType")
         // the properties below are optional
         .resourceLabel("resourceLabel")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.Builder	builder()
String	getPredefinedLoadMetricType()	The metric type.
default String	getResourceLabel()	Identifies the resource associated with the metric type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPredefinedLoadMetricType

@Stability(Stable)
@NotNull
String getPredefinedLoadMetricType()

The metric type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-predefinedloadmetrictype

getResourceLabel

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

Identifies the resource associated with the metric type.

You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer 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 is app/invalid input: '<'load-balancer-name>/invalid input: '<'load-balancer-id>/targetgroup/invalid input: '<'target-group-name>/invalid input: '<'target-group-id>, 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.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-resourcelabel

builder

@Stability(Stable)
static CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.Builder builder()

Returns:

a CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.Builder of CfnScalingPlan.PredefinedLoadMetricSpecificationProperty