Interface CfnScalingPolicy.MetricStatProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnScalingPolicy.MetricStatProperty.Jsii$Proxy
- Enclosing class:
CfnScalingPolicy
@Stability(Stable)
public static interface CfnScalingPolicy.MetricStatProperty
extends software.amazon.jsii.JsiiSerializable
MetricStat
is a property of the AWS::AutoScaling::ScalingPolicy MetricDataQuery property type.
This structure defines the CloudWatch metric to return, along with the statistic and unit.
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.*; MetricStatProperty metricStatProperty = MetricStatProperty.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 .unit("unit") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnScalingPolicy.MetricStatProperty
static final class
An implementation forCfnScalingPolicy.MetricStatProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMetric
The CloudWatch metric to return, including the metric name, namespace, and dimensions.To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- See Also:
-
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 metrics for predictive scaling are
Average
andSum
.- See Also:
-
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:
-
builder
-