ExecutePolicyRequest (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class ExecutePolicyRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the ExecutePolicy operation.
Executes the specified policy.

See Also:
AmazonAutoScaling.executePolicy(ExecutePolicyRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExecutePolicyRequest()

Constructors
Constructor and Description
`ExecutePolicyRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAutoScalingGroupName()` The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
`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.
`String`	`getPolicyName()` The name or ARN of the policy you want to run.
`int`	`hashCode()`
`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(String autoScalingGroupName)` The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
`void`	`setHonorCooldown(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(String policyName)` The name or ARN of the policy you want to run.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ExecutePolicyRequest`	`withAutoScalingGroupName(String autoScalingGroupName)` The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
`ExecutePolicyRequest`	`withHonorCooldown(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(String policyName)` The name or ARN of the policy you want to run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, 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 String getAutoScalingGroupName()
```
    The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
    Constraints:
    Length: 1 - 1600
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Returns:
    The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
  - setAutoScalingGroupName
```
public void setAutoScalingGroupName(String autoScalingGroupName)
```
    The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
    Constraints:
    Length: 1 - 1600
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Parameters:
    autoScalingGroupName - The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
  - withAutoScalingGroupName
```
public ExecutePolicyRequest withAutoScalingGroupName(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: [ -퟿-�𐀀-􏿿\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 String getPolicyName()
```
    The name or ARN of the policy you want to run.
    Constraints:
    Length: 1 - 1600
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Returns:
    The name or ARN of the policy you want to run.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The name or ARN of the policy you want to run.
    Constraints:
    Length: 1 - 1600
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Parameters:
    policyName - The name or ARN of the policy you want to run.
  - withPolicyName
```
public ExecutePolicyRequest withPolicyName(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: [ -퟿-�𐀀-􏿿\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 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(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(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 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 String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class ExecutePolicyRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ExecutePolicyRequest

Method Detail

getAutoScalingGroupName

setAutoScalingGroupName

withAutoScalingGroupName

getPolicyName

setPolicyName

withPolicyName

isHonorCooldown

setHonorCooldown

withHonorCooldown

getHonorCooldown

toString

hashCode

equals