Package software.amazon.awssdk.services.autoscaling.model

Class ExecutePolicyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.autoscaling.model.ExecutePolicyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public class ExecutePolicyRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExecutePolicyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	autoScalingGroupName()	The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Double	breachThreshold()	The breach threshold for the alarm.
static ExecutePolicyRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
Boolean	honorCooldown()	If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
Double	metricValue()	The metric value to compare to BreachThreshold.
String	policyName()	The name or ARN of the policy.
static Class<? extends ExecutePolicyRequest.Builder>	serializableBuilderClass()
ExecutePolicyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

autoScalingGroupName

public String autoScalingGroupName()

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

policyName

public String policyName()

The name or ARN of the policy.

Returns:

The name or ARN of the policy.

honorCooldown

public Boolean honorCooldown()

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.

This parameter is not supported if the policy type is StepScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Returns:

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.

This parameter is not supported if the policy type is StepScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

metricValue

public Double metricValue()

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

breachThreshold

public Double breachThreshold()

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

toBuilder

public ExecutePolicyRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

Returns:

a builder for type T

builder

public static ExecutePolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ExecutePolicyRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object