software.amazon.awssdk.services.autoscaling.model

Class PredefinedMetricSpecification

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.PredefinedMetricSpecification

All Implemented Interfaces:

ToCopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>

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

Configures a predefined metric for a target tracking policy.

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)
<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.
static Class<? extends PredefinedMetricSpecification.Builder>	serializableBuilderClass()
PredefinedMetricSpecification.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

predefinedMetricType

public MetricType predefinedMetricType()

The metric type.

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.

See Also:

MetricType

predefinedMetricTypeAsString

public String predefinedMetricTypeAsString()

The metric type.

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.

See Also:

MetricType

resourceLabel

public String resourceLabel()

Identifies the resource associated with the metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - average CPU utilization of the Auto Scaling group

• ASGAverageNetworkIn - average number of bytes received on all network interfaces by the Auto Scaling group

• ASGAverageNetworkOut - average number of bytes sent out on all network interfaces by the Auto Scaling group

• ALBRequestCountPerTarget - number of requests completed per target in an Application Load Balancer target group

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

Returns:

Identifies the resource associated with the metric type. The following predefined metrics are available:

• ASGAverageCPUUtilization - average CPU utilization of the Auto Scaling group

• ASGAverageNetworkIn - average number of bytes received on all network interfaces by the Auto Scaling group

• ASGAverageNetworkOut - average number of bytes sent out on all network interfaces by the Auto Scaling group

• ALBRequestCountPerTarget - number of requests completed per target in an Application Load Balancer target group

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

toBuilder

public PredefinedMetricSpecification.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<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>

Returns:

a builder for type T

builder

public static PredefinedMetricSpecification.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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