Class ExecutePolicyRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.autoscaling.model.ExecutePolicyRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • ExecutePolicyRequest

      public ExecutePolicyRequest()
  • Method Details

    • setAutoScalingGroupName

      public void setAutoScalingGroupName(String autoScalingGroupName)

      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

      public String 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

      public ExecutePolicyRequest withAutoScalingGroupName(String autoScalingGroupName)

      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

      public void setPolicyName(String policyName)

      The name or ARN of the policy.

      Parameters:
      policyName - The name or ARN of the policy.
    • getPolicyName

      public String getPolicyName()

      The name or ARN of the policy.

      Returns:
      The name or ARN of the policy.
    • withPolicyName

      public ExecutePolicyRequest withPolicyName(String policyName)

      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

      public void setHonorCooldown(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.

      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

      public 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.

      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

      public ExecutePolicyRequest withHonorCooldown(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.

      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

      public 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.

      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

      public void setMetricValue(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.

      Parameters:
      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.

    • getMetricValue

      public 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.

      Returns:
      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.

    • withMetricValue

      public ExecutePolicyRequest withMetricValue(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setBreachThreshold

      public void setBreachThreshold(Double breachThreshold)

      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

      public Double 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

      public ExecutePolicyRequest withBreachThreshold(Double breachThreshold)

      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

      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ExecutePolicyRequest 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 class AmazonWebServiceRequest
      See Also: