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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PredefinedMetricSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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()
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.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 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 returnMetricType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompredefinedMetricTypeAsString()
.- 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:
MetricType
-
-
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 returnMetricType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompredefinedMetricTypeAsString()
.- 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:
MetricType
-
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PredefinedMetricSpecification.Builder,PredefinedMetricSpecification>
-
builder
public static PredefinedMetricSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends PredefinedMetricSpecification.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.
-
-