Package software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.TargetTrackingMetricStatProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.TargetTrackingMetricStatProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

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

This structure defines the CloudWatch metric to return, along with the statistic and unit.

TargetTrackingMetricStat is a property of the TargetTrackingMetricDataQuery object.

For more information about the CloudWatch terminology below, 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.autoscaling.*;
 TargetTrackingMetricStatProperty targetTrackingMetricStatProperty = TargetTrackingMetricStatProperty.builder()
         .metric(MetricProperty.builder()
                 .metricName("metricName")
                 .namespace("namespace")
                 // the properties below are optional
                 .dimensions(List.of(MetricDimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .stat("stat")
         // the properties below are optional
         .period(123)
         .unit("unit")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.TargetTrackingMetricStatProperty.Builder	builder()
Object	getMetric()	The metric to use.
default Number	getPeriod()	The period of the metric in seconds.
String	getStat()	The statistic to return.
default String	getUnit()	The unit to use for the returned data points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetric

@Stability(Stable)
@NotNull
Object getMetric()

The metric to use.

See Also:

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

getStat

@Stability(Stable)
@NotNull
String getStat()

The statistic to return.

It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .

The most commonly used metric for scaling is Average .

See Also:

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

getPeriod

@Stability(Stable)
@Nullable
default Number getPeriod()

The period of the metric in seconds.

The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see Create a target tracking policy using high-resolution metrics for faster response .

See Also:

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

getUnit

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

The unit to use for the returned data points.

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

See Also:

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

builder

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

Returns:

a CfnScalingPolicy.TargetTrackingMetricStatProperty.Builder of CfnScalingPolicy.TargetTrackingMetricStatProperty