/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.autoscaling.model; import java.io.Serializable; import javax.annotation.Generated; /** *

* Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PredefinedMetricSpecification implements Serializable, Cloneable { /** *

* 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. *
*

*/ private String predefinedMetricType; /** *

* 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. *

*/ private String resourceLabel; /** *

* 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. *
*

* * @param 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *

* 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. *
*

* 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. *

* 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. *
*

* 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. *

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public PredefinedMetricSpecification withResourceLabel(String resourceLabel) { setResourceLabel(resourceLabel); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPredefinedMetricType() != null) sb.append("PredefinedMetricType: ").append(getPredefinedMetricType()).append(","); if (getResourceLabel() != null) sb.append("ResourceLabel: ").append(getResourceLabel()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PredefinedMetricSpecification == false) return false; PredefinedMetricSpecification other = (PredefinedMetricSpecification) obj; if (other.getPredefinedMetricType() == null ^ this.getPredefinedMetricType() == null) return false; if (other.getPredefinedMetricType() != null && other.getPredefinedMetricType().equals(this.getPredefinedMetricType()) == false) return false; if (other.getResourceLabel() == null ^ this.getResourceLabel() == null) return false; if (other.getResourceLabel() != null && other.getResourceLabel().equals(this.getResourceLabel()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPredefinedMetricType() == null) ? 0 : getPredefinedMetricType().hashCode()); hashCode = prime * hashCode + ((getResourceLabel() == null) ? 0 : getResourceLabel().hashCode()); return hashCode; } @Override public PredefinedMetricSpecification clone() { try { return (PredefinedMetricSpecification) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }