software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.CustomizedMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.CustomizedMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(value=Stable)
public static interface CfnScalingPolicy.CustomizedMetricSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling.

For information about the available metrics for a service, see AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .

To create your customized metric specification:

• Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish custom metrics in the Amazon CloudWatch User Guide .
• Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.

For an example of how creating new metrics can be useful, see Scaling based on Amazon SQS in the Amazon EC2 Auto Scaling User Guide . This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts .

CustomizedMetricSpecification is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration 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.applicationautoscaling.*;
 CustomizedMetricSpecificationProperty customizedMetricSpecificationProperty = CustomizedMetricSpecificationProperty.builder()
         .metricName("metricName")
         .namespace("namespace")
         .statistic("statistic")
         // the properties below are optional
         .dimensions(List.of(MetricDimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .unit("unit")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder	builder()
default Object	getDimensions() The dimensions of the metric.
String	getMetricName() The name of the metric.
String	getNamespace() The namespace of the metric.
String	getStatistic() The statistic of the metric.
default String	getUnit() The unit of the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

The name of the metric.

To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics .

getNamespace

@Stability(value=Stable)
 @NotNull
String getNamespace()

The namespace of the metric.

getStatistic

@Stability(value=Stable)
 @NotNull
String getStatistic()

The statistic of the metric.

getDimensions

@Stability(value=Stable)
 @Nullable
default Object getDimensions()

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

getUnit

@Stability(value=Stable)
 @Nullable
default String getUnit()

The unit of the metric.

For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .

builder

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

Returns:

a CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder of CfnScalingPolicy.CustomizedMetricSpecificationProperty