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()` Identifies the resource associated with the metric type.
`int`	`hashCode()`
`void`	`setPredefinedMetricType(MetricType predefinedMetricType)` The metric type.
`void`	`setPredefinedMetricType(String predefinedMetricType)` The metric type.
`void`	`setResourceLabel(String resourceLabel)` Identifies the resource associated with the metric type.
`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)` Identifies the resource associated with the metric type.

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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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 - Number of requests completed per target in an Application Load Balancer target 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)
```
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group 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.
    Parameters:
    resourceLabel - Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group 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.
  - getResourceLabel
```
public String getResourceLabel()
```
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group 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 ALBRequestCountPerTarget and there is a target group 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.
  - withResourceLabel
```
public PredefinedMetricSpecification withResourceLabel(String resourceLabel)
```
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group 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.
    Parameters:
    resourceLabel - Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group 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:
    
    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

Did this page help you?

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