Struct PredictiveScalingPolicyConfiguration 

#[non_exhaustive]
pub struct PredictiveScalingPolicyConfiguration {
    pub metric_specifications: Vec<PredictiveScalingMetricSpecification>,
    pub mode: Option<PredictiveScalingMode>,
    pub scheduling_buffer_time: Option<i32>,
    pub max_capacity_breach_behavior: Option<PredictiveScalingMaxCapacityBreachBehavior>,
    pub max_capacity_buffer: Option<i32>,
}

Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.

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.

metric_specifications: Vec<PredictiveScalingMetricSpecification>

This structure includes the metrics and target utilization to use for predictive scaling.

This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

mode: Option<PredictiveScalingMode>

The predictive scaling mode. Defaults to ForecastOnly if not specified.

scheduling_buffer_time: Option<i32>

The amount of time, in seconds, that the start time can be advanced.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

max_capacity_breach_behavior: Option<PredictiveScalingMaxCapacityBreachBehavior>

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.

max_capacity_buffer: Option<i32>

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

Implementations

impl PredictiveScalingPolicyConfiguration

pub fn metric_specifications(&self) -> &[PredictiveScalingMetricSpecification]

This structure includes the metrics and target utilization to use for predictive scaling.

This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

pub fn mode(&self) -> Option<&PredictiveScalingMode>

The predictive scaling mode. Defaults to ForecastOnly if not specified.

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

The amount of time, in seconds, that the start time can be advanced.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

pub fn max_capacity_breach_behavior( &self, ) -> Option<&PredictiveScalingMaxCapacityBreachBehavior>

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.

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

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

impl PredictiveScalingPolicyConfiguration

pub fn builder() -> PredictiveScalingPolicyConfigurationBuilder

Creates a new builder-style object to manufacture PredictiveScalingPolicyConfiguration.

Trait Implementations

impl Clone for PredictiveScalingPolicyConfiguration

fn clone(&self) -> PredictiveScalingPolicyConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PredictiveScalingPolicyConfiguration

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

Formats the value using the given formatter.

impl PartialEq for PredictiveScalingPolicyConfiguration

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