Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

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

CustomizedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling ( Auto Scaling Plans ).

To create your customized scaling metric specification:

• Add values for each required property 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.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch 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.*;
 CustomizedScalingMetricSpecificationProperty customizedScalingMetricSpecificationProperty = CustomizedScalingMetricSpecificationProperty.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	Description
static final class	CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder	A builder for CfnScalingPlan.CustomizedScalingMetricSpecificationProperty
static final class	CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Jsii$Proxy	An implementation for CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.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 Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

The name of the metric.

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

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

The namespace of the metric.

getStatistic

@Stability(Stable)
@NotNull
String getStatistic()

The statistic of the metric.

getDimensions

@Stability(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(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(Stable)
static CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder builder()

Returns:

a CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder of CfnScalingPlan.CustomizedScalingMetricSpecificationProperty