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(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder	builder()
String	getPredefinedMetricType() 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 Detail

getPredefinedMetricType

@Stability(value=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 - Number of requests completed per target in an Application Load Balancer target group.

getResourceLabel

@Stability(value=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 attached to the Auto Scaling group.

The format is app/ *load-balancer-name* / *load-balancer-id* /targetgroup/ *target-group-name* / *target-group-id* , where

• app/ *load-balancer-name* / *load-balancer-id* is the final portion of the load balancer ARN, and
• targetgroup/ *target-group-name* / *target-group-id* is the final portion of the target group ARN.

builder

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

Returns:

a CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder of CfnScalingPolicy.PredefinedMetricSpecificationProperty