Class ExecutePolicyRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name or Amazon Resource Name (ARN) of the Auto Scaling group.The breach threshold for the alarm.If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.The metric value to compare toBreachThreshold
.The name or ARN of the policy.int
hashCode()
If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.void
setAutoScalingGroupName
(String autoScalingGroupName) The name or Amazon Resource Name (ARN) of the Auto Scaling group.void
setBreachThreshold
(Double breachThreshold) The breach threshold for the alarm.void
setHonorCooldown
(Boolean honorCooldown) If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.void
setMetricValue
(Double metricValue) The metric value to compare toBreachThreshold
.void
setPolicyName
(String policyName) The name or ARN of the policy.toString()
Returns a string representation of this object; useful for testing and debugging.withAutoScalingGroupName
(String autoScalingGroupName) The name or Amazon Resource Name (ARN) of the Auto Scaling group.withBreachThreshold
(Double breachThreshold) The breach threshold for the alarm.withHonorCooldown
(Boolean honorCooldown) If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.withMetricValue
(Double metricValue) The metric value to compare toBreachThreshold
.withPolicyName
(String policyName) The name or ARN of the policy.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ExecutePolicyRequest
public ExecutePolicyRequest()
-
-
Method Details
-
setAutoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
- Parameters:
autoScalingGroupName
- The name or Amazon Resource Name (ARN) of the Auto Scaling group.
-
getAutoScalingGroupName
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.
-
withAutoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
- Parameters:
autoScalingGroupName
- The name or Amazon Resource Name (ARN) of the Auto Scaling group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPolicyName
The name or ARN of the policy.
- Parameters:
policyName
- The name or ARN of the policy.
-
getPolicyName
The name or ARN of the policy.
- Returns:
- The name or ARN of the policy.
-
withPolicyName
The name or ARN of the policy.
- Parameters:
policyName
- The name or ARN of the policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHonorCooldown
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 Developer Guide.
- Parameters:
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 Developer Guide.
-
getHonorCooldown
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 Developer 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 Developer Guide.
-
withHonorCooldown
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 Developer Guide.
- Parameters:
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 Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isHonorCooldown
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 Developer 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 Developer Guide.
-
setMetricValue
The metric value to compare to
BreachThreshold
. This enables you to execute a policy of typeStepScaling
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.- Parameters:
metricValue
- The metric value to compare toBreachThreshold
. This enables you to execute a policy of typeStepScaling
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.
-
getMetricValue
The metric value to compare to
BreachThreshold
. This enables you to execute a policy of typeStepScaling
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 typeStepScaling
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.
-
withMetricValue
The metric value to compare to
BreachThreshold
. This enables you to execute a policy of typeStepScaling
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.- Parameters:
metricValue
- The metric value to compare toBreachThreshold
. This enables you to execute a policy of typeStepScaling
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:
- Returns a reference to this object so that method calls can be chained together.
-
setBreachThreshold
The breach threshold for the alarm.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.- Parameters:
breachThreshold
- The breach threshold for the alarm.This parameter is required if the policy type is
StepScaling
and not supported otherwise.
-
getBreachThreshold
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.
-
withBreachThreshold
The breach threshold for the alarm.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.- Parameters:
breachThreshold
- The breach threshold for the alarm.This parameter is required if the policy type is
StepScaling
and not supported otherwise.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-