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

Interface ExecutePolicyRequest.Builder

All Superinterfaces:
AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>, SdkBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ExecutePolicyRequest
public static interface ExecutePolicyRequest.Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<ExecutePolicyRequest.Builder,ExecutePolicyRequest>

  • Method Details

    • autoScalingGroupName

      ExecutePolicyRequest.Builder autoScalingGroupName(String autoScalingGroupName)

      The name of the Auto Scaling group.

      Parameters:
      autoScalingGroupName - The name 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)

      Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

      Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      honorCooldown - Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

      Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 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.

      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.

      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.

      Required if the policy type is StepScaling and not supported otherwise.

      Parameters:
      breachThreshold - The breach threshold for the alarm.

      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.

    • overrideConfiguration

      ExecutePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ExecutePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.