Struct aws_sdk_autoscaling::client::fluent_builders::ExecutePolicy

pub struct ExecutePolicy { /* private fields */ }

Fluent builder constructing a request to ExecutePolicy.

Executes the specified policy. This can be useful for testing the design of your scaling policy.

Implementations

impl ExecutePolicy

pub async fn customize(
    self
) -> Result<CustomizableOperation<ExecutePolicy, AwsResponseRetryClassifier>, SdkError<ExecutePolicyError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ExecutePolicyOutput, SdkError<ExecutePolicyError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self

The name of the Auto Scaling group.

pub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self

The name of the Auto Scaling group.

pub fn policy_name(self, input: impl Into<String>) -> Self

The name or ARN of the policy.

pub fn set_policy_name(self, input: Option<String>) -> Self

The name or ARN of the policy.

pub fn honor_cooldown(self, input: bool) -> Self

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.

pub fn set_honor_cooldown(self, input: Option<bool>) -> Self

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.

pub fn metric_value(self, input: f64) -> Self

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.

pub fn set_metric_value(self, input: Option<f64>) -> Self

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.

pub fn breach_threshold(self, input: f64) -> Self

The breach threshold for the alarm.

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

pub fn set_breach_threshold(self, input: Option<f64>) -> Self

The breach threshold for the alarm.

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

Trait Implementations

impl Clone for ExecutePolicy

fn clone(&self) -> ExecutePolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecutePolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.