PredefinedMetricSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.PredefinedMetricSpecification

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PredefinedMetricSpecification
extends Object
implements Serializable, Cloneable
```
Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PredefinedMetricSpecification()

Constructors
Constructor and Description
`PredefinedMetricSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PredefinedMetricSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getPredefinedMetricType()` The metric type.
`String`	`getResourceLabel()` 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.
`int`	`hashCode()`
`void`	`setPredefinedMetricType(MetricType predefinedMetricType)` The metric type.
`void`	`setPredefinedMetricType(String predefinedMetricType)` The metric type.
`void`	`setResourceLabel(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.
`String`	`toString()` Returns a string representation of this object.
`PredefinedMetricSpecification`	`withPredefinedMetricType(MetricType predefinedMetricType)` The metric type.
`PredefinedMetricSpecification`	`withPredefinedMetricType(String predefinedMetricType)` The metric type.
`PredefinedMetricSpecification`	`withResourceLabel(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PredefinedMetricSpecification
```
public PredefinedMetricSpecification()
```
- Method Detail
  - setPredefinedMetricType
```
public void setPredefinedMetricType(String 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.
    Parameters:
    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.
    See Also:
    
    MetricType
  - getPredefinedMetricType
```
public String getPredefinedMetricType()
```
    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.
    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
  - withPredefinedMetricType
```
public PredefinedMetricSpecification withPredefinedMetricType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricType
  - setPredefinedMetricType
```
public void setPredefinedMetricType(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.
    Parameters:
    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.
    See Also:
    
    MetricType
  - withPredefinedMetricType
```
public PredefinedMetricSpecification withPredefinedMetricType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricType
  - setResourceLabel
```
public void setResourceLabel(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.
    Parameters:
    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.
  - getResourceLabel
```
public String getResourceLabel()
```
    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.
  - withResourceLabel
```
public PredefinedMetricSpecification withResourceLabel(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PredefinedMetricSpecification clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.781

Class PredefinedMetricSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PredefinedMetricSpecification

Method Detail

setPredefinedMetricType

getPredefinedMetricType

withPredefinedMetricType

setPredefinedMetricType

withPredefinedMetricType

setResourceLabel

getResourceLabel

withResourceLabel

toString

equals

hashCode

clone