software.amazon.awssdk.services.autoscalingplans.model

Class CustomizedScalingMetricSpecification

java.lang.Object

software.amazon.awssdk.services.autoscalingplans.model.CustomizedScalingMetricSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomizedScalingMetricSpecification.Builder,CustomizedScalingMetricSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public final class CustomizedScalingMetricSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomizedScalingMetricSpecification.Builder,CustomizedScalingMetricSpecification>

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

• Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

• Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomizedScalingMetricSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static CustomizedScalingMetricSpecification.Builder	builder()
List<MetricDimension>	dimensions() The dimensions of the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions() For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
String	metricName() The name of the metric.
String	namespace() The namespace of the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomizedScalingMetricSpecification.Builder>	serializableBuilderClass()
MetricStatistic	statistic() The statistic of the metric.
String	statisticAsString() The statistic of the metric.
CustomizedScalingMetricSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	unit() The unit of the metric.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

metricName

public final String metricName()

The name of the metric.

Returns:

The name of the metric.

namespace

public final String namespace()

The namespace of the metric.

Returns:

The namespace of the metric.

hasDimensions

public final boolean hasDimensions()

For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dimensions

public final List<MetricDimension> dimensions()

The dimensions of the metric.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

Returns:

The dimensions of the metric.

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

statistic

public final MetricStatistic statistic()

The statistic of the metric.

If the service returns an enum value that is not available in the current SDK version, statistic will return MetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

Returns:

The statistic of the metric.

See Also:

MetricStatistic

statisticAsString

public final String statisticAsString()

The statistic of the metric.

If the service returns an enum value that is not available in the current SDK version, statistic will return MetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

Returns:

The statistic of the metric.

See Also:

MetricStatistic

unit

public final String unit()

The unit of the metric.

Returns:

The unit of the metric.

toBuilder

public CustomizedScalingMetricSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomizedScalingMetricSpecification.Builder,CustomizedScalingMetricSpecification>

builder

public static CustomizedScalingMetricSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends CustomizedScalingMetricSpecification.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo