software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

All Known Implementing Classes:

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

public static interface CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

`CustomizedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) 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 and Description
static class	CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder A builder for CfnScalingPlan.CustomizedScalingMetricSpecificationProperty
static class	CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Jsii$Proxy An implementation for CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

Method Summary

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

Method Detail

getMetricName

java.lang.String getMetricName()

The name of the metric.

getNamespace

java.lang.String getNamespace()

The namespace of the metric.

getStatistic

java.lang.String getStatistic()

The statistic of the metric.

getDimensions

default java.lang.Object getDimensions()

The dimensions of the metric.

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

getUnit

default java.lang.String getUnit()

The unit of the metric.

builder

static CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder builder()

Returns:

a CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Builder of CfnScalingPlan.CustomizedScalingMetricSpecificationProperty