Class CustomizedMetricSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.CustomizedMetricSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CustomizedMetricSpecification.Builder,CustomizedMetricSpecification>
@Generated("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 property 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 the CloudWatch terminology below, see Amazon CloudWatch concepts.
Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CustomizedMetricSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CustomizedMetricSpecification.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()
boolean
hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property.String
metricName()
The name of the metric.List<TargetTrackingMetricDataQuery>
metrics()
The metrics to include in the target tracking scaling policy, as a metric data query.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()
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. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
- Returns:
- 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.
-
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 theisEmpty()
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 scaling policy.
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 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 returnMetricStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- 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 returnMetricStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic of the metric.
- See Also:
MetricStatistic
-
unit
public final 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.
- Returns:
- 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.
-
hasMetrics
public final boolean hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
metrics
public final List<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.
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
hasMetrics()
method.- Returns:
- 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.
-
toBuilder
public CustomizedMetricSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CustomizedMetricSpecification.Builder,CustomizedMetricSpecification>
-
builder
public static CustomizedMetricSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends CustomizedMetricSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-