software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.MetricProperty

All Known Implementing Classes:

CfnScalingPolicy.MetricProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

public static interface CfnScalingPolicy.MetricProperty

Represents a specific metric.

Metric is a property of the AWS::AutoScaling::ScalingPolicy MetricStat 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.*;
 MetricProperty metricProperty = MetricProperty.builder()
         .metricName("metricName")
         .namespace("namespace")
         // the properties below are optional
         .dimensions(List.of(MetricDimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicy.MetricProperty.Builder	builder()
default java.lang.Object	getDimensions() The dimensions for the metric.
java.lang.String	getMetricName() The name of the metric.
java.lang.String	getNamespace() The namespace 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.

For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .

getDimensions

default java.lang.Object getDimensions()

The dimensions for the metric.

For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .

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

builder

static CfnScalingPolicy.MetricProperty.Builder builder()

Returns:

a CfnScalingPolicy.MetricProperty.Builder of CfnScalingPolicy.MetricProperty