Class: Aws::ApplicationAutoScaling::Types::PredictiveScalingPolicyConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationAutoScaling::Types::PredictiveScalingPolicyConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-applicationautoscaling/types.rb

Overview

Represents a predictive scaling policy configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_capacity_breach_behavior ⇒ String

  Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity.

• #max_capacity_buffer ⇒ Integer

  The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

• #metric_specifications ⇒ Array<Types::PredictiveScalingMetricSpecification>

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

• #mode ⇒ String

  The predictive scaling mode.

• #scheduling_buffer_time ⇒ Integer

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

Instance Attribute Details

#max_capacity_breach_behavior ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2187

class PredictiveScalingPolicyConfiguration < Struct.new(
  :metric_specifications,
  :mode,
  :scheduling_buffer_time,
  :max_capacity_breach_behavior,
  :max_capacity_buffer)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity_buffer ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2187

class PredictiveScalingPolicyConfiguration < Struct.new(
  :metric_specifications,
  :mode,
  :scheduling_buffer_time,
  :max_capacity_breach_behavior,
  :max_capacity_buffer)
  SENSITIVE = []
  include Aws::Structure
end

#metric_specifications ⇒ Array<Types::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.

Returns:

• (Array<Types::PredictiveScalingMetricSpecification>)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2187

class PredictiveScalingPolicyConfiguration < Struct.new(
  :metric_specifications,
  :mode,
  :scheduling_buffer_time,
  :max_capacity_breach_behavior,
  :max_capacity_buffer)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2187

class PredictiveScalingPolicyConfiguration < Struct.new(
  :metric_specifications,
  :mode,
  :scheduling_buffer_time,
  :max_capacity_breach_behavior,
  :max_capacity_buffer)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_buffer_time ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2187

class PredictiveScalingPolicyConfiguration < Struct.new(
  :metric_specifications,
  :mode,
  :scheduling_buffer_time,
  :max_capacity_breach_behavior,
  :max_capacity_buffer)
  SENSITIVE = []
  include Aws::Structure
end