Package software.amazon.awssdk.services.autoscaling.model

Interface ExecutePolicyRequest.Builder

All Superinterfaces:

CopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>, SdkBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

Enclosing class:

ExecutePolicyRequest

public static interface ExecutePolicyRequest.Builder
extends CopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

Method Summary

Modifier and Type	Method	Description
ExecutePolicyRequest.Builder	autoScalingGroupName(String autoScalingGroupName)	The name or Amazon Resource Name (ARN) of the Auto Scaling group.
ExecutePolicyRequest.Builder	breachThreshold(Double breachThreshold)	The breach threshold for the alarm.
ExecutePolicyRequest.Builder	honorCooldown(Boolean honorCooldown)	If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
ExecutePolicyRequest.Builder	metricValue(Double metricValue)	The metric value to compare to BreachThreshold.
ExecutePolicyRequest.Builder	policyName(String policyName)	The name or ARN of the policy.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

autoScalingGroupName

ExecutePolicyRequest.Builder autoScalingGroupName(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.

policyName

ExecutePolicyRequest.Builder policyName(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.

honorCooldown

ExecutePolicyRequest.Builder honorCooldown(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 User 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 User Guide.

Returns:

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

metricValue

ExecutePolicyRequest.Builder metricValue(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.

breachThreshold

ExecutePolicyRequest.Builder breachThreshold(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.