software.amazon.awssdk.services.autoscaling.model

Class CustomizedMetricSpecification

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.CustomizedMetricSpecification

All Implemented Interfaces:

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

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

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized 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 more information about CloudWatch, see Amazon CloudWatch Concepts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomizedMetricSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static CustomizedMetricSpecification.Builder	builder()
List<MetricDimension>	dimensions() The dimensions of the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions() Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	metricName() The name of the metric.
String	namespace() The namespace of the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomizedMetricSpecification.Builder>	serializableBuilderClass()
MetricStatistic	statistic() The statistic of the metric.
String	statisticAsString() The statistic of the metric.
CustomizedMetricSpecification.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	unit() The unit of the metric.

Methods inherited from class java.lang.Object

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()

Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 scaling policy.

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

You can use hasDimensions() to see if a value was sent in this field.

Returns:

The dimensions of the metric.

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

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 CustomizedMetricSpecification.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CustomizedMetricSpecification.Builder,CustomizedMetricSpecification>

Returns:

a builder for type T

builder

public static CustomizedMetricSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends CustomizedMetricSpecification.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.