software.amazon.awscdk.services.autoscaling

Class CfnScalingPolicy.MetricDataQueryProperty.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnScalingPolicy.MetricDataQueryProperty.Builder

Enclosing interface:

CfnScalingPolicy.MetricDataQueryProperty

public static final class CfnScalingPolicy.MetricDataQueryProperty.Builder
extends java.lang.Object

A builder for CfnScalingPolicy.MetricDataQueryProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnScalingPolicy.MetricDataQueryProperty	build() Builds the configured instance.
CfnScalingPolicy.MetricDataQueryProperty.Builder	expression(java.lang.String expression) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getExpression()
CfnScalingPolicy.MetricDataQueryProperty.Builder	id(java.lang.String id) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getId()
CfnScalingPolicy.MetricDataQueryProperty.Builder	label(java.lang.String label) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getLabel()
CfnScalingPolicy.MetricDataQueryProperty.Builder	metricStat(CfnScalingPolicy.MetricStatProperty metricStat) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getMetricStat()
CfnScalingPolicy.MetricDataQueryProperty.Builder	metricStat(IResolvable metricStat) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getMetricStat()
CfnScalingPolicy.MetricDataQueryProperty.Builder	returnData(java.lang.Boolean returnData) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getReturnData()
CfnScalingPolicy.MetricDataQueryProperty.Builder	returnData(IResolvable returnData) Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getReturnData()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

id

public CfnScalingPolicy.MetricDataQueryProperty.Builder id(java.lang.String id)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getId()

Parameters:

id - A short name that identifies the object's results in the response. This parameter is required. 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.

Returns:

this

expression

public CfnScalingPolicy.MetricDataQueryProperty.Builder expression(java.lang.String expression)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.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 MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

Returns:

this

label

public CfnScalingPolicy.MetricDataQueryProperty.Builder label(java.lang.String label)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.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

public CfnScalingPolicy.MetricDataQueryProperty.Builder metricStat(IResolvable metricStat)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getMetricStat()

Parameters:

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

Returns:

this

metricStat

public CfnScalingPolicy.MetricDataQueryProperty.Builder metricStat(CfnScalingPolicy.MetricStatProperty metricStat)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.getMetricStat()

Parameters:

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

Returns:

this

returnData

public CfnScalingPolicy.MetricDataQueryProperty.Builder returnData(java.lang.Boolean returnData)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.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

public CfnScalingPolicy.MetricDataQueryProperty.Builder returnData(IResolvable returnData)

Sets the value of CfnScalingPolicy.MetricDataQueryProperty.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

public CfnScalingPolicy.MetricDataQueryProperty build()

Builds the configured instance.

Returns:

a new instance of CfnScalingPolicy.MetricDataQueryProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided