com.amazonaws.services.autoscalingplans.model

Class PredefinedScalingMetricSpecification

java.lang.Object

com.amazonaws.services.autoscalingplans.model.PredefinedScalingMetricSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PredefinedScalingMetricSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PredefinedScalingMetricSpecification()

Method Summary

Modifier and Type	Method and Description
PredefinedScalingMetricSpecification	clone()
boolean	equals(Object obj)
String	getPredefinedScalingMetricType() The metric type.
String	getResourceLabel() Identifies the resource associated with the metric type.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPredefinedScalingMetricType(String predefinedScalingMetricType) The metric type.
void	setResourceLabel(String resourceLabel) Identifies the resource associated with the metric type.
String	toString() Returns a string representation of this object.
PredefinedScalingMetricSpecification	withPredefinedScalingMetricType(ScalingMetricType predefinedScalingMetricType) The metric type.
PredefinedScalingMetricSpecification	withPredefinedScalingMetricType(String predefinedScalingMetricType) The metric type.
PredefinedScalingMetricSpecification	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

PredefinedScalingMetricSpecification

public PredefinedScalingMetricSpecification()

Method Detail

setPredefinedScalingMetricType

public void setPredefinedScalingMetricType(String predefinedScalingMetricType)

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Parameters:

predefinedScalingMetricType - The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

See Also:

ScalingMetricType

getPredefinedScalingMetricType

public String getPredefinedScalingMetricType()

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Returns:

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

See Also:

ScalingMetricType

withPredefinedScalingMetricType

public PredefinedScalingMetricSpecification withPredefinedScalingMetricType(String predefinedScalingMetricType)

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Parameters:

predefinedScalingMetricType - The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingMetricType

withPredefinedScalingMetricType

public PredefinedScalingMetricSpecification withPredefinedScalingMetricType(ScalingMetricType predefinedScalingMetricType)

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Parameters:

predefinedScalingMetricType - The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingMetricType

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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 PredefinedScalingMetricSpecification 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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

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 PredefinedScalingMetricSpecification clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.