software.amazon.awssdk.services.autoscalingplans.model

Class PredefinedLoadMetricSpecification

java.lang.Object

software.amazon.awssdk.services.autoscalingplans.model.PredefinedLoadMetricSpecification

All Implemented Interfaces:

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

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

Represents a predefined metric that can be used for predictive scaling.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredefinedLoadMetricSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static PredefinedLoadMetricSpecification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LoadMetricType	predefinedLoadMetricType() The metric type.
String	predefinedLoadMetricTypeAsString() The metric type.
String	resourceLabel() Identifies the resource associated with the metric type.
List<SdkField<?>>	sdkFields()
static Class<? extends PredefinedLoadMetricSpecification.Builder>	serializableBuilderClass()
PredefinedLoadMetricSpecification.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

predefinedLoadMetricType

public final LoadMetricType predefinedLoadMetricType()

The metric type.

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

Returns:

The metric type.

See Also:

LoadMetricType

predefinedLoadMetricTypeAsString

public final String predefinedLoadMetricTypeAsString()

The metric type.

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

Returns:

The metric type.

See Also:

LoadMetricType

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 ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

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 is 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

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

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

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 ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

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 is 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

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

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

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

Specified by:

toBuilder in interface ToCopyableBuilder<PredefinedLoadMetricSpecification.Builder,PredefinedLoadMetricSpecification>

builder

public static PredefinedLoadMetricSpecification.Builder builder()

serializableBuilderClass

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