Struct ExecutePolicyInput 

#[non_exhaustive]
pub struct ExecutePolicyInput {
    pub auto_scaling_group_name: Option<String>,
    pub policy_name: Option<String>,
    pub honor_cooldown: Option<bool>,
    pub metric_value: Option<f64>,
    pub breach_threshold: Option<f64>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

auto_scaling_group_name: Option<String>

The name of the Auto Scaling group.

policy_name: Option<String>

The name or ARN of the policy.

honor_cooldown: Option<bool>

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.

metric_value: Option<f64>

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.

breach_threshold: Option<f64>

The breach threshold for the alarm.

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

Implementations

impl ExecutePolicyInput

pub fn auto_scaling_group_name(&self) -> Option<&str>

The name of the Auto Scaling group.

pub fn policy_name(&self) -> Option<&str>

The name or ARN of the policy.

pub fn honor_cooldown(&self) -> Option<bool>

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) -> Option<f64>

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) -> Option<f64>

The breach threshold for the alarm.

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

impl ExecutePolicyInput

pub fn builder() -> ExecutePolicyInputBuilder

Creates a new builder-style object to manufacture ExecutePolicyInput.

Trait Implementations

impl Clone for ExecutePolicyInput

fn clone(&self) -> ExecutePolicyInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutePolicyInput

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

Formats the value using the given formatter.

impl PartialEq for ExecutePolicyInput

fn eq(&self, other: &ExecutePolicyInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecutePolicyInput