Class CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.autoscaling.CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty>
- Enclosing interface:
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty
@Stability(Stable)
public static final class CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.expression(String expression) Sets the value ofCfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getId()metricStat(IResolvable metricStat) returnData(Boolean returnData) returnData(IResolvable returnData)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
expression
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder expression(String expression) - Parameters:
expression- The math expression to perform on the returned data, if this object is performing a math expression. This expression can use theIdof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.- Returns:
this
-
id
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder id(String id) Sets the value ofCfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getId()- Parameters:
id- A short name that identifies the object's results in the response. This name must be unique among allTargetTrackingMetricDataQueryobjects 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.- Returns:
this
-
label
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder label(String label) - Parameters:
label- 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.- Returns:
this
-
metricStat
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder metricStat(IResolvable metricStat) - Parameters:
metricStat- Information about the metric data to return. Conditional: Within eachTargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.- Returns:
this
-
metricStat
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder metricStat(CfnScalingPolicyPropsMixin.TargetTrackingMetricStatProperty metricStat) - Parameters:
metricStat- Information about the metric data to return. Conditional: Within eachTargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.- Returns:
this
-
period
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder period(Number period) - Parameters:
period- 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 .- Returns:
this
-
returnData
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder returnData(Boolean returnData) - Parameters:
returnData- Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specifytruefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor 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).- Returns:
this
-
returnData
@Stability(Stable) public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder returnData(IResolvable returnData) - Parameters:
returnData- Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specifytruefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor 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).- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty>- Returns:
- a new instance of
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty - Throws:
NullPointerException- if any required attribute was not provided
-