Package software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.MetricProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.MetricProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(Stable)
public static interface CfnScalingPolicy.MetricProperty
extends software.amazon.jsii.JsiiSerializable

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html

Nested Class Summary

Nested Classes

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

Method Summary

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-metricname

getNamespace

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-namespace

getDimensions

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-dimensions

builder

@Stability(Stable)
static CfnScalingPolicy.MetricProperty.Builder builder()

Returns:

a CfnScalingPolicy.MetricProperty.Builder of CfnScalingPolicy.MetricProperty