Struct ScalingPolicy 

#[non_exhaustive]
pub struct ScalingPolicy {

    pub auto_scaling_group_name: Option<String>,
    pub policy_name: Option<String>,
    pub policy_arn: Option<String>,
    pub policy_type: Option<String>,
    pub adjustment_type: Option<String>,
    pub min_adjustment_step: Option<i32>,
    pub min_adjustment_magnitude: Option<i32>,
    pub scaling_adjustment: Option<i32>,
    pub cooldown: Option<i32>,
    pub step_adjustments: Option<Vec<StepAdjustment>>,
    pub metric_aggregation_type: Option<String>,
    pub estimated_instance_warmup: Option<i32>,
    pub alarms: Option<Vec<Alarm>>,
    pub target_tracking_configuration: Option<TargetTrackingConfiguration>,
    pub enabled: Option<bool>,
    pub predictive_scaling_configuration: Option<PredictiveScalingConfiguration>,
}

Describes a scaling policy.

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 of the scaling policy.

policy_arn: Option<String>

The Amazon Resource Name (ARN) of the policy.

policy_type: Option<String>

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

adjustment_type: Option<String>

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

min_adjustment_step: Option<i32>

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

min_adjustment_magnitude: Option<i32>

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

scaling_adjustment: Option<i32>

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

cooldown: Option<i32>

The duration of the policy's cooldown period, in seconds.

step_adjustments: Option<Vec<StepAdjustment>>

A set of adjustments that enable you to scale based on the size of the alarm breach.

metric_aggregation_type: Option<String>

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

estimated_instance_warmup: Option<i32>

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

alarms: Option<Vec<Alarm>>

The CloudWatch alarms related to the policy.

target_tracking_configuration: Option<TargetTrackingConfiguration>

A target tracking scaling policy.

enabled: Option<bool>

Indicates whether the policy is enabled (true) or disabled (false).

predictive_scaling_configuration: Option<PredictiveScalingConfiguration>

A predictive scaling policy.

Implementations

impl ScalingPolicy

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 of the scaling policy.

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

The Amazon Resource Name (ARN) of the policy.

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

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

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

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

pub fn min_adjustment_step(&self) -> Option<i32>

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

pub fn min_adjustment_magnitude(&self) -> Option<i32>

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

pub fn scaling_adjustment(&self) -> Option<i32>

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

pub fn cooldown(&self) -> Option<i32>

The duration of the policy's cooldown period, in seconds.

pub fn step_adjustments(&self) -> &[StepAdjustment]

A set of adjustments that enable you to scale based on the size of the alarm breach.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .step_adjustments.is_none().

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

pub fn estimated_instance_warmup(&self) -> Option<i32>

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

pub fn alarms(&self) -> &[Alarm]

The CloudWatch alarms related to the policy.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .alarms.is_none().

pub fn target_tracking_configuration( &self, ) -> Option<&TargetTrackingConfiguration>

A target tracking scaling policy.

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

Indicates whether the policy is enabled (true) or disabled (false).

pub fn predictive_scaling_configuration( &self, ) -> Option<&PredictiveScalingConfiguration>

A predictive scaling policy.

impl ScalingPolicy

pub fn builder() -> ScalingPolicyBuilder

Creates a new builder-style object to manufacture ScalingPolicy.

Trait Implementations

impl Clone for ScalingPolicy

fn clone(&self) -> ScalingPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScalingPolicy

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

Formats the value using the given formatter.

impl PartialEq for ScalingPolicy

fn eq(&self, other: &ScalingPolicy) -> 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 ScalingPolicy