Package software.amazon.awscdk.cfnpropertymixins.services.autoscaling

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>

A builder for CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty	build()	Builds the configured instance.
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	expression(String expression)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getExpression()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	id(String id)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getId()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	label(String label)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getLabel()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	metricStat(CfnScalingPolicyPropsMixin.TargetTrackingMetricStatProperty metricStat)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getMetricStat()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	metricStat(IResolvable metricStat)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getMetricStat()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	period(Number period)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getPeriod()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	returnData(Boolean returnData)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getReturnData()
CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder	returnData(IResolvable returnData)	Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getReturnData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

expression

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder expression(String expression)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getExpression()

Parameters:

expression - 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.

Returns:

this

id

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder id(String id)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getId()

Parameters:

id - A short name that identifies the object's results in the response. This name must be unique among all TargetTrackingMetricDataQuery 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.

Returns:

this

label

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder label(String label)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getLabel()

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)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getMetricStat()

Parameters:

metricStat - Information about the metric data to return. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

Returns:

this

metricStat

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder metricStat(CfnScalingPolicyPropsMixin.TargetTrackingMetricStatProperty metricStat)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getMetricStat()

Parameters:

metricStat - Information about the metric data to return. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

Returns:

this

period

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder period(Number period)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getPeriod()

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)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getReturnData()

Parameters:

returnData - 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 ).

Returns:

this

returnData

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.Builder returnData(IResolvable returnData)

Sets the value of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty.getReturnData()

Parameters:

returnData - 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 ).

Returns:

this

build

@Stability(Stable)
public CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty>

Returns:

a new instance of CfnScalingPolicyPropsMixin.TargetTrackingMetricDataQueryProperty

Throws:

NullPointerException - if any required attribute was not provided