Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.PredefinedScalingMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

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

PredefinedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration that specifies a customized scaling metric for a target tracking configuration to use with a scaling plan.

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.*;
 PredefinedScalingMetricSpecificationProperty predefinedScalingMetricSpecificationProperty = PredefinedScalingMetricSpecificationProperty.builder()
         .predefinedScalingMetricType("predefinedScalingMetricType")
         // the properties below are optional
         .resourceLabel("resourceLabel")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.Builder	builder()
String	getPredefinedScalingMetricType()	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

getPredefinedScalingMetricType

@Stability(Stable)
@NotNull
String getPredefinedScalingMetricType()

The metric type.

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

See Also:

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

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 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/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-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel

builder

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

Returns:

a CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.Builder of CfnScalingPlan.PredefinedScalingMetricSpecificationProperty