AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::AutoScaling::Model::PredictiveScalingConfiguration Class Reference

#include <PredictiveScalingConfiguration.h>

Public Member Functions

 PredictiveScalingConfiguration ()
 
 PredictiveScalingConfiguration (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PredictiveScalingConfigurationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::Vector< PredictiveScalingMetricSpecification > & GetMetricSpecifications () const
 
bool MetricSpecificationsHasBeenSet () const
 
void SetMetricSpecifications (const Aws::Vector< PredictiveScalingMetricSpecification > &value)
 
void SetMetricSpecifications (Aws::Vector< PredictiveScalingMetricSpecification > &&value)
 
PredictiveScalingConfigurationWithMetricSpecifications (const Aws::Vector< PredictiveScalingMetricSpecification > &value)
 
PredictiveScalingConfigurationWithMetricSpecifications (Aws::Vector< PredictiveScalingMetricSpecification > &&value)
 
PredictiveScalingConfigurationAddMetricSpecifications (const PredictiveScalingMetricSpecification &value)
 
PredictiveScalingConfigurationAddMetricSpecifications (PredictiveScalingMetricSpecification &&value)
 
const PredictiveScalingModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const PredictiveScalingMode &value)
 
void SetMode (PredictiveScalingMode &&value)
 
PredictiveScalingConfigurationWithMode (const PredictiveScalingMode &value)
 
PredictiveScalingConfigurationWithMode (PredictiveScalingMode &&value)
 
int GetSchedulingBufferTime () const
 
bool SchedulingBufferTimeHasBeenSet () const
 
void SetSchedulingBufferTime (int value)
 
PredictiveScalingConfigurationWithSchedulingBufferTime (int value)
 
const PredictiveScalingMaxCapacityBreachBehaviorGetMaxCapacityBreachBehavior () const
 
bool MaxCapacityBreachBehaviorHasBeenSet () const
 
void SetMaxCapacityBreachBehavior (const PredictiveScalingMaxCapacityBreachBehavior &value)
 
void SetMaxCapacityBreachBehavior (PredictiveScalingMaxCapacityBreachBehavior &&value)
 
PredictiveScalingConfigurationWithMaxCapacityBreachBehavior (const PredictiveScalingMaxCapacityBreachBehavior &value)
 
PredictiveScalingConfigurationWithMaxCapacityBreachBehavior (PredictiveScalingMaxCapacityBreachBehavior &&value)
 
int GetMaxCapacityBuffer () const
 
bool MaxCapacityBufferHasBeenSet () const
 
void SetMaxCapacityBuffer (int value)
 
PredictiveScalingConfigurationWithMaxCapacityBuffer (int value)
 

Detailed Description

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

See Also:

AWS API Reference

Definition at line 35 of file PredictiveScalingConfiguration.h.

Constructor & Destructor Documentation

◆ PredictiveScalingConfiguration() [1/2]

Aws::AutoScaling::Model::PredictiveScalingConfiguration::PredictiveScalingConfiguration ( )

◆ PredictiveScalingConfiguration() [2/2]

Aws::AutoScaling::Model::PredictiveScalingConfiguration::PredictiveScalingConfiguration ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddMetricSpecifications() [1/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::AddMetricSpecifications ( const PredictiveScalingMetricSpecification value)
inline

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.

Definition at line 107 of file PredictiveScalingConfiguration.h.

◆ AddMetricSpecifications() [2/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::AddMetricSpecifications ( PredictiveScalingMetricSpecification &&  value)
inline

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.

Definition at line 116 of file PredictiveScalingConfiguration.h.

◆ GetMaxCapacityBreachBehavior()

const PredictiveScalingMaxCapacityBreachBehavior& Aws::AutoScaling::Model::PredictiveScalingConfiguration::GetMaxCapacityBreachBehavior ( ) const
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 221 of file PredictiveScalingConfiguration.h.

◆ GetMaxCapacityBuffer()

int Aws::AutoScaling::Model::PredictiveScalingConfiguration::GetMaxCapacityBuffer ( ) const
inline

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.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

Definition at line 305 of file PredictiveScalingConfiguration.h.

◆ GetMetricSpecifications()

const Aws::Vector<PredictiveScalingMetricSpecification>& Aws::AutoScaling::Model::PredictiveScalingConfiguration::GetMetricSpecifications ( ) const
inline

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.

Definition at line 53 of file PredictiveScalingConfiguration.h.

◆ GetMode()

const PredictiveScalingMode& Aws::AutoScaling::Model::PredictiveScalingConfiguration::GetMode ( ) const
inline

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

Definition at line 123 of file PredictiveScalingConfiguration.h.

◆ GetSchedulingBufferTime()

int Aws::AutoScaling::Model::PredictiveScalingConfiguration::GetSchedulingBufferTime ( ) const
inline

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

Definition at line 167 of file PredictiveScalingConfiguration.h.

◆ MaxCapacityBreachBehaviorHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingConfiguration::MaxCapacityBreachBehaviorHasBeenSet ( ) const
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 235 of file PredictiveScalingConfiguration.h.

◆ MaxCapacityBufferHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingConfiguration::MaxCapacityBufferHasBeenSet ( ) const
inline

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.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

Definition at line 318 of file PredictiveScalingConfiguration.h.

◆ MetricSpecificationsHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingConfiguration::MetricSpecificationsHasBeenSet ( ) const
inline

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.

Definition at line 62 of file PredictiveScalingConfiguration.h.

◆ ModeHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingConfiguration::ModeHasBeenSet ( ) const
inline

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

Definition at line 129 of file PredictiveScalingConfiguration.h.

◆ operator=()

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SchedulingBufferTimeHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingConfiguration::SchedulingBufferTimeHasBeenSet ( ) const
inline

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

Definition at line 180 of file PredictiveScalingConfiguration.h.

◆ SetMaxCapacityBreachBehavior() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMaxCapacityBreachBehavior ( const PredictiveScalingMaxCapacityBreachBehavior value)
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 249 of file PredictiveScalingConfiguration.h.

◆ SetMaxCapacityBreachBehavior() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMaxCapacityBreachBehavior ( PredictiveScalingMaxCapacityBreachBehavior &&  value)
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 263 of file PredictiveScalingConfiguration.h.

◆ SetMaxCapacityBuffer()

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMaxCapacityBuffer ( int  value)
inline

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.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

Definition at line 331 of file PredictiveScalingConfiguration.h.

◆ SetMetricSpecifications() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMetricSpecifications ( Aws::Vector< PredictiveScalingMetricSpecification > &&  value)
inline

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.

Definition at line 80 of file PredictiveScalingConfiguration.h.

◆ SetMetricSpecifications() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMetricSpecifications ( const Aws::Vector< PredictiveScalingMetricSpecification > &  value)
inline

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.

Definition at line 71 of file PredictiveScalingConfiguration.h.

◆ SetMode() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMode ( const PredictiveScalingMode value)
inline

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

Definition at line 135 of file PredictiveScalingConfiguration.h.

◆ SetMode() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetMode ( PredictiveScalingMode &&  value)
inline

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

Definition at line 141 of file PredictiveScalingConfiguration.h.

◆ SetSchedulingBufferTime()

void Aws::AutoScaling::Model::PredictiveScalingConfiguration::SetSchedulingBufferTime ( int  value)
inline

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

Definition at line 193 of file PredictiveScalingConfiguration.h.

◆ WithMaxCapacityBreachBehavior() [1/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMaxCapacityBreachBehavior ( const PredictiveScalingMaxCapacityBreachBehavior value)
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 277 of file PredictiveScalingConfiguration.h.

◆ WithMaxCapacityBreachBehavior() [2/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMaxCapacityBreachBehavior ( PredictiveScalingMaxCapacityBreachBehavior &&  value)
inline

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

The following are possible values:

  • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

Definition at line 291 of file PredictiveScalingConfiguration.h.

◆ WithMaxCapacityBuffer()

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMaxCapacityBuffer ( int  value)
inline

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.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

Definition at line 344 of file PredictiveScalingConfiguration.h.

◆ WithMetricSpecifications() [1/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMetricSpecifications ( Aws::Vector< PredictiveScalingMetricSpecification > &&  value)
inline

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.

Definition at line 98 of file PredictiveScalingConfiguration.h.

◆ WithMetricSpecifications() [2/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMetricSpecifications ( const Aws::Vector< PredictiveScalingMetricSpecification > &  value)
inline

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.

Definition at line 89 of file PredictiveScalingConfiguration.h.

◆ WithMode() [1/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMode ( const PredictiveScalingMode value)
inline

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

Definition at line 147 of file PredictiveScalingConfiguration.h.

◆ WithMode() [2/2]

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithMode ( PredictiveScalingMode &&  value)
inline

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

Definition at line 153 of file PredictiveScalingConfiguration.h.

◆ WithSchedulingBufferTime()

PredictiveScalingConfiguration& Aws::AutoScaling::Model::PredictiveScalingConfiguration::WithSchedulingBufferTime ( int  value)
inline

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

Definition at line 206 of file PredictiveScalingConfiguration.h.


The documentation for this class was generated from the following file: