software.amazon.awssdk.services.applicationautoscaling.model

Class PredefinedMetricSpecification

java.lang.Object

software.amazon.awssdk.services.applicationautoscaling.model.PredefinedMetricSpecification

All Implemented Interfaces:

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

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

Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building dashboards with CloudWatch in the Application Auto Scaling User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredefinedMetricSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static PredefinedMetricSpecification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MetricType	predefinedMetricType() The metric type.
String	predefinedMetricTypeAsString() The metric type.
String	resourceLabel() Identifies the resource associated with the metric type.
List<SdkField<?>>	sdkFields()
static Class<? extends PredefinedMetricSpecification.Builder>	serializableBuilderClass()
PredefinedMetricSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

predefinedMetricType

public final MetricType predefinedMetricType()

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.

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

Returns:

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.

See Also:

MetricType

predefinedMetricTypeAsString

public final String predefinedMetricTypeAsString()

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.

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

Returns:

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.

See Also:

MetricType

resourceLabel

public final String resourceLabel()

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

• app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

• targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Returns:

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

• app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

• targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

toBuilder

public PredefinedMetricSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>

builder

public static PredefinedMetricSpecification.Builder builder()

serializableBuilderClass

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