Package software.amazon.awssdk.services.autoscaling.model

Interface TargetTrackingMetricStat.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TargetTrackingMetricStat.Builder,TargetTrackingMetricStat>, SdkBuilder<TargetTrackingMetricStat.Builder,TargetTrackingMetricStat>, SdkPojo

Enclosing class:

TargetTrackingMetricStat

public static interface TargetTrackingMetricStat.Builder
extends SdkPojo, CopyableBuilder<TargetTrackingMetricStat.Builder,TargetTrackingMetricStat>

Method Summary

Modifier and Type	Method	Description
default TargetTrackingMetricStat.Builder	metric(Consumer<Metric.Builder> metric)	The metric to use.
TargetTrackingMetricStat.Builder	metric(Metric metric)	The metric to use.
TargetTrackingMetricStat.Builder	period(Integer period)	The period of the metric in seconds.
TargetTrackingMetricStat.Builder	stat(String stat)	The statistic to return.
TargetTrackingMetricStat.Builder	unit(String unit)	The unit to use for the returned data points.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

metric

TargetTrackingMetricStat.Builder metric(Metric metric)

The metric to use.

Parameters:

metric - The metric to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

metric

default TargetTrackingMetricStat.Builder metric(Consumer<Metric.Builder> metric)

The metric to use.

This is a convenience method that creates an instance of the Metric.Builder avoiding the need to create one manually via Metric.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metric(Metric).

Parameters:

metric - a consumer that will call methods on Metric.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

metric(Metric)

stat

TargetTrackingMetricStat.Builder stat(String stat)

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metric for scaling is Average.

Parameters:

stat - The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metric for scaling is Average.

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

TargetTrackingMetricStat.Builder unit(String unit)

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Parameters:

unit - The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

period

TargetTrackingMetricStat.Builder period(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.