@Stability(value=Stable)
public static interface CfnScalingPolicy.CustomizedMetricSpecificationProperty
extends software.amazon.jsii.JsiiSerializable
For information about the available metrics for a service, see AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
To create your customized metric specification:
For an example of how creating new metrics can be useful, see Scaling based on Amazon SQS in the Amazon EC2 Auto Scaling User Guide . This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts .
CustomizedMetricSpecification
is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration 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.applicationautoscaling.*; CustomizedMetricSpecificationProperty customizedMetricSpecificationProperty = CustomizedMetricSpecificationProperty.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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder
A builder for
CfnScalingPolicy.CustomizedMetricSpecificationProperty |
static class |
CfnScalingPolicy.CustomizedMetricSpecificationProperty.Jsii$Proxy
An implementation for
CfnScalingPolicy.CustomizedMetricSpecificationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder |
builder() |
default Object |
getDimensions()
The dimensions of the metric.
|
String |
getMetricName()
The name of the metric.
|
String |
getNamespace()
The namespace of the metric.
|
String |
getStatistic()
The statistic of the metric.
|
default String |
getUnit()
The unit of the metric.
|
@Stability(value=Stable) @NotNull String getMetricName()
To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics .
@Stability(value=Stable) @NotNull String getNamespace()
@Stability(value=Stable) @NotNull String getStatistic()
@Stability(value=Stable) @Nullable default Object getDimensions()
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
@Stability(value=Stable) @Nullable default String getUnit()
For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
@Stability(value=Stable) static CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder builder()
Copyright © 2023. All rights reserved.