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

Configures a predefined metric for a target tracking policy.

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; useful for testing and debugging.
`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.
    
    Parameters:
    
    predefinedMetricType - The metric type.
    
    See Also:
    
    MetricType
  - getPredefinedMetricType
```
public String getPredefinedMetricType()
```
    The metric type.
    
    Returns:
    
    The metric type.
    
    See Also:
    
    MetricType
  - withPredefinedMetricType
```
public PredefinedMetricSpecification withPredefinedMetricType(String predefinedMetricType)
```
    The metric type.
    
    Parameters:
    
    predefinedMetricType - The metric type.
    
    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.
    
    Parameters:
    
    predefinedMetricType - The metric type.
    
    See Also:
    
    MetricType
  - withPredefinedMetricType
```
public PredefinedMetricSpecification withPredefinedMetricType(MetricType predefinedMetricType)
```
    The metric type.
    
    Parameters:
    
    predefinedMetricType - The metric type.
    
    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. 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
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
    Parameters:
    resourceLabel - Identifies the resource associated with 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
    
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
  - getResourceLabel
```
public String getResourceLabel()
```
    Identifies the resource associated with 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
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
    Returns:
    Identifies the resource associated with 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
    
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
  - withResourceLabel
```
public PredefinedMetricSpecification withResourceLabel(String resourceLabel)
```
    Identifies the resource associated with 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
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
    Parameters:
    resourceLabel - Identifies the resource associated with 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
    
    For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
    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; useful for testing and debugging.
    
    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