Class PredefinedMetricSpecification

java.lang.Object
software.amazon.awssdk.services.autoscaling.model.PredefinedMetricSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>
@Generated("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 Amazon EC2 Auto Scaling.

See Also:

  • Method Details

    • predefinedMetricType

      public final MetricType predefinedMetricType()

      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 - Average Application Load Balancer request count per target for your Auto Scaling group.

      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 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 - Average Application Load Balancer request count per target for your Auto Scaling group.

      See Also:

    • predefinedMetricTypeAsString

      public final String predefinedMetricTypeAsString()

      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 - Average Application Load Balancer request count per target for your Auto Scaling group.

      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 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 - Average Application Load Balancer request count per target for your Auto Scaling group.

      See Also:

    • resourceLabel

      public final String resourceLabel()

      A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 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:
      A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 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()
      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 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.