Interface CustomizedMetricSpecification.Builder

All Superinterfaces:

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

Enclosing class:

CustomizedMetricSpecification

@Mutable
@NotThreadSafe
public static interface CustomizedMetricSpecification.Builder
extends SdkPojo, CopyableBuilder<CustomizedMetricSpecification.Builder,CustomizedMetricSpecification>

Method Summary

Modifier and Type	Method	Description
CustomizedMetricSpecification.Builder	dimensions(Collection<MetricDimension> dimensions)	The dimensions of the metric.
CustomizedMetricSpecification.Builder	dimensions(Consumer<MetricDimension.Builder>... dimensions)	The dimensions of the metric.
CustomizedMetricSpecification.Builder	dimensions(MetricDimension... dimensions)	The dimensions of the metric.
CustomizedMetricSpecification.Builder	metricName(String metricName)	The name of the metric.
CustomizedMetricSpecification.Builder	metrics(Collection<TargetTrackingMetricDataQuery> metrics)	The metrics to include in the target tracking scaling policy, as a metric data query.
CustomizedMetricSpecification.Builder	metrics(Consumer<TargetTrackingMetricDataQuery.Builder>... metrics)	The metrics to include in the target tracking scaling policy, as a metric data query.
CustomizedMetricSpecification.Builder	metrics(TargetTrackingMetricDataQuery... metrics)	The metrics to include in the target tracking scaling policy, as a metric data query.
CustomizedMetricSpecification.Builder	namespace(String namespace)	The namespace of the metric.
CustomizedMetricSpecification.Builder	period(Integer period)	The period of the metric in seconds.
CustomizedMetricSpecification.Builder	statistic(String statistic)	The statistic of the metric.
CustomizedMetricSpecification.Builder	statistic(MetricStatistic statistic)	The statistic of the metric.
CustomizedMetricSpecification.Builder	unit(String unit)	The unit of the metric.

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 Details

metricName

CustomizedMetricSpecification.Builder metricName(String metricName)

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Parameters:

metricName - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Returns:

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

namespace

CustomizedMetricSpecification.Builder namespace(String namespace)

The namespace of the metric.

Parameters:

namespace - The namespace of the metric.

Returns:

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

dimensions

CustomizedMetricSpecification.Builder dimensions(Collection<MetricDimension> dimensions)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

Parameters:

dimensions - The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

Returns:

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

dimensions

CustomizedMetricSpecification.Builder dimensions(MetricDimension... dimensions)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

Parameters:

dimensions - The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

Returns:

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

dimensions

CustomizedMetricSpecification.Builder dimensions(Consumer<MetricDimension.Builder>... dimensions)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<MetricDimension>).

Parameters:

dimensions - a consumer that will call methods on MetricDimension.Builder

Returns:

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

See Also:

• dimensions(java.util.Collection<MetricDimension>)

statistic

CustomizedMetricSpecification.Builder statistic(String statistic)

The statistic of the metric.

Parameters:

statistic - The statistic of the metric.

Returns:

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

See Also:

• MetricStatistic
• MetricStatistic

statistic

CustomizedMetricSpecification.Builder statistic(MetricStatistic statistic)

The statistic of the metric.

Parameters:

statistic - The statistic of the metric.

Returns:

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

See Also:

• MetricStatistic
• MetricStatistic

unit

CustomizedMetricSpecification.Builder unit(String unit)

The unit of the metric. 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 of the metric. 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

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

metrics

CustomizedMetricSpecification.Builder metrics(Collection<TargetTrackingMetricDataQuery> metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Parameters:

metrics - The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Returns:

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

metrics

CustomizedMetricSpecification.Builder metrics(TargetTrackingMetricDataQuery... metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Parameters:

metrics - The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Returns:

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

metrics

CustomizedMetricSpecification.Builder metrics(Consumer<TargetTrackingMetricDataQuery.Builder>... metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(List<TargetTrackingMetricDataQuery>).

Parameters:

metrics - a consumer that will call methods on TargetTrackingMetricDataQuery.Builder

Returns:

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

See Also:

• metrics(java.util.Collection<TargetTrackingMetricDataQuery>)