Package software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.TargetTrackingMetricDataQueryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.TargetTrackingMetricDataQueryProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

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

The metric data to return.

Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.

For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the Application Auto Scaling User Guide .

TargetTrackingMetricDataQuery is a property of the AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification 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.*;
 TargetTrackingMetricDataQueryProperty targetTrackingMetricDataQueryProperty = TargetTrackingMetricDataQueryProperty.builder()
         .expression("expression")
         .id("id")
         .label("label")
         .metricStat(TargetTrackingMetricStatProperty.builder()
                 .metric(TargetTrackingMetricProperty.builder()
                         .dimensions(List.of(TargetTrackingMetricDimensionProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .metricName("metricName")
                         .namespace("namespace")
                         .build())
                 .stat("stat")
                 .unit("unit")
                 .build())
         .returnData(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.TargetTrackingMetricDataQueryProperty.Builder	builder()
default String	getExpression()	The math expression to perform on the returned data, if this object is performing a math expression.
default String	getId()	A short name that identifies the object's results in the response.
default String	getLabel()	A human-readable label for this metric or expression.
default Object	getMetricStat()	Information about the metric data to return.
default Object	getReturnData()	Indicates whether to return the timestamps and raw data values of this metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExpression

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

The math expression to perform on the returned data, if this object is performing a math expression.

This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-expression

getId

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

A short name that identifies the object's results in the response.

This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-id

getLabel

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

A human-readable label for this metric or expression.

This is especially useful if this is a math expression, so that you know what the value represents.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-label

getMetricStat

@Stability(Stable)
@Nullable
default Object getMetricStat()

Information about the metric data to return.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-metricstat

getReturnData

@Stability(Stable)
@Nullable
default Object getReturnData()

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-returndata

builder

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

Returns:

a CfnScalingPolicy.TargetTrackingMetricDataQueryProperty.Builder of CfnScalingPolicy.TargetTrackingMetricDataQueryProperty