software.amazon.awssdk.services.autoscaling.model

Class ExecutePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecutePolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	autoScalingGroupName() The name of the Auto Scaling group.
Double	breachThreshold() The breach threshold for the alarm.
static ExecutePolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	honorCooldown() Indicates whether Amazon EC2 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.
List<SdkField<?>>	sdkFields()
static Class<? extends ExecutePolicyRequest.Builder>	serializableBuilderClass()
ExecutePolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

autoScalingGroupName

public final String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

policyName

public final String policyName()

The name or ARN of the policy.

Returns:

The name or ARN of the policy.

honorCooldown

public final Boolean honorCooldown()

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Returns:

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

metricValue

public final 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.

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.

Required if the policy type is StepScaling and not supported otherwise.

breachThreshold

public final Double breachThreshold()

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

Returns:

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

toBuilder

public ExecutePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

Specified by:

toBuilder in class AutoScalingRequest

builder

public static ExecutePolicyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo