com.amazonaws.services.autoscaling.model
Class ExecutePolicyRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.autoscaling.model.ExecutePolicyRequest

All Implemented Interfaces:

java.io.Serializable

public class ExecutePolicyRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the ExecutePolicy operation.

Executes the specified policy.

See Also:

AmazonAutoScaling.executePolicy(ExecutePolicyRequest), Serialized Form

Constructor Summary

ExecutePolicyRequest()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getAutoScalingGroupName() The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
java.lang.Boolean	getHonorCooldown() Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
java.lang.String	getPolicyName() The name or ARN of the policy you want to run.
int	hashCode()
java.lang.Boolean	isHonorCooldown() Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
void	setAutoScalingGroupName(java.lang.String autoScalingGroupName) The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
void	setHonorCooldown(java.lang.Boolean honorCooldown) Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
void	setPolicyName(java.lang.String policyName) The name or ARN of the policy you want to run.
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 the Amazon Resource Name (ARN) of the Auto Scaling group.
ExecutePolicyRequest	withHonorCooldown(java.lang.Boolean honorCooldown) Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
ExecutePolicyRequest	withPolicyName(java.lang.String policyName) The name or ARN of the policy you want to run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutePolicyRequest

public ExecutePolicyRequest()

Method Detail

getAutoScalingGroupName

public java.lang.String getAutoScalingGroupName()

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

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

setAutoScalingGroupName

public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

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

withAutoScalingGroupName

public ExecutePolicyRequest withAutoScalingGroupName(java.lang.String autoScalingGroupName)

The name or the 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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyName

public java.lang.String getPolicyName()

The name or ARN of the policy you want to run.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name or ARN of the policy you want to run.

setPolicyName

public void setPolicyName(java.lang.String policyName)

The name or ARN of the policy you want to run.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

policyName - The name or ARN of the policy you want to run.

withPolicyName

public ExecutePolicyRequest withPolicyName(java.lang.String policyName)

The name or ARN of the policy you want to run.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

policyName - The name or ARN of the policy you want to run.

Returns:

A reference to this updated object so that method calls can be chained together.

isHonorCooldown

public java.lang.Boolean isHonorCooldown()

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

Returns:

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

setHonorCooldown

public void setHonorCooldown(java.lang.Boolean honorCooldown)

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

Parameters:

honorCooldown - Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

withHonorCooldown

public ExecutePolicyRequest withHonorCooldown(java.lang.Boolean honorCooldown)

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

honorCooldown - Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getHonorCooldown

public java.lang.Boolean getHonorCooldown()

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

Returns:

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object