public class ExecutePolicyRequest extends AmazonWebServiceRequest implements java.io.Serializable
Executes the specified policy.
Constructor and Description |
---|
ExecutePolicyRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAutoScalingGroupName()
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
|
java.lang.Double |
getBreachThreshold()
The breach threshold for the alarm.
|
java.lang.Boolean |
getHonorCooldown()
If this parameter is true, Auto Scaling waits for the cooldown period to
complete before executing the policy.
|
java.lang.Double |
getMetricValue()
The metric value to compare to
BreachThreshold . |
java.lang.String |
getPolicyName()
The name or ARN of the policy.
|
int |
hashCode() |
java.lang.Boolean |
isHonorCooldown()
If this parameter is true, Auto Scaling waits for the cooldown period to
complete before executing the policy.
|
void |
setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
|
void |
setBreachThreshold(java.lang.Double breachThreshold)
The breach threshold for the alarm.
|
void |
setHonorCooldown(java.lang.Boolean honorCooldown)
If this parameter is true, Auto Scaling waits for the cooldown period to
complete before executing the policy.
|
void |
setMetricValue(java.lang.Double metricValue)
The metric value to compare to
BreachThreshold . |
void |
setPolicyName(java.lang.String policyName)
The name or ARN of the policy.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ExecutePolicyRequest |
withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
|
ExecutePolicyRequest |
withBreachThreshold(java.lang.Double breachThreshold)
The breach threshold for the alarm.
|
ExecutePolicyRequest |
withHonorCooldown(java.lang.Boolean honorCooldown)
If this parameter is true, Auto Scaling waits for the cooldown period to
complete before executing the policy.
|
ExecutePolicyRequest |
withMetricValue(java.lang.Double metricValue)
The metric value to compare to
BreachThreshold . |
ExecutePolicyRequest |
withPolicyName(java.lang.String policyName)
The name or ARN of the policy.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getAutoScalingGroupName()
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name or Amazon Resource Name (ARN) of the Auto Scaling group.
public ExecutePolicyRequest withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name or Amazon Resource Name (ARN) of the Auto Scaling group.
public java.lang.String getPolicyName()
The name or ARN of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name or ARN of the policy.
public void setPolicyName(java.lang.String policyName)
The name or ARN of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
policyName
- The name or ARN of the policy.
public ExecutePolicyRequest withPolicyName(java.lang.String policyName)
The name or ARN of the policy.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
policyName
- The name or ARN of the policy.
public java.lang.Boolean 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.
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.
public java.lang.Boolean 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.
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.
public void setHonorCooldown(java.lang.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 Developer Guide.
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.
public ExecutePolicyRequest withHonorCooldown(java.lang.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 Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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.
public java.lang.Double getMetricValue()
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.
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.
public void setMetricValue(java.lang.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.
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.
public ExecutePolicyRequest withMetricValue(java.lang.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 a reference to this object so that method calls can be chained together.
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.
public java.lang.Double getBreachThreshold()
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
The breach threshold for the alarm.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public void setBreachThreshold(java.lang.Double breachThreshold)
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
breachThreshold
- The breach threshold for the alarm.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public ExecutePolicyRequest withBreachThreshold(java.lang.Double breachThreshold)
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
Returns a reference to this object so that method calls can be chained together.
breachThreshold
- The breach threshold for the alarm.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.