@Generated(value="software.amazon.awssdk:codegen") public class ExecutePolicyRequest extends AutoScalingRequest implements ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ExecutePolicyRequest.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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() |
requestOverrideConfig
copy
public String autoScalingGroupName()
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
public String policyName()
The name or ARN of the policy.
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.
This parameter is not supported if the policy type is StepScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
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.
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.
public Double breachThreshold()
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
public ExecutePolicyRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>
toBuilder
in class AutoScalingRequest
public static ExecutePolicyRequest.Builder builder()
public static Class<? extends ExecutePolicyRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.