AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::ScalingConfiguration Class Reference

#include <ScalingConfiguration.h>

Public Member Functions

 ScalingConfiguration ()
 
 ScalingConfiguration (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ScalingConfigurationoperator= (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
 
int GetMinCapacity () const
 
bool MinCapacityHasBeenSet () const
 
void SetMinCapacity (int value)
 
ScalingConfigurationWithMinCapacity (int value)
 
int GetMaxCapacity () const
 
bool MaxCapacityHasBeenSet () const
 
void SetMaxCapacity (int value)
 
ScalingConfigurationWithMaxCapacity (int value)
 
bool GetAutoPause () const
 
bool AutoPauseHasBeenSet () const
 
void SetAutoPause (bool value)
 
ScalingConfigurationWithAutoPause (bool value)
 
int GetSecondsUntilAutoPause () const
 
bool SecondsUntilAutoPauseHasBeenSet () const
 
void SetSecondsUntilAutoPause (int value)
 
ScalingConfigurationWithSecondsUntilAutoPause (int value)
 
const Aws::StringGetTimeoutAction () const
 
bool TimeoutActionHasBeenSet () const
 
void SetTimeoutAction (const Aws::String &value)
 
void SetTimeoutAction (Aws::String &&value)
 
void SetTimeoutAction (const char *value)
 
ScalingConfigurationWithTimeoutAction (const Aws::String &value)
 
ScalingConfigurationWithTimeoutAction (Aws::String &&value)
 
ScalingConfigurationWithTimeoutAction (const char *value)
 

Detailed Description

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

See Also:

AWS API Reference

Definition at line 35 of file ScalingConfiguration.h.

Constructor & Destructor Documentation

◆ ScalingConfiguration() [1/2]

Aws::RDS::Model::ScalingConfiguration::ScalingConfiguration ( )

◆ ScalingConfiguration() [2/2]

Aws::RDS::Model::ScalingConfiguration::ScalingConfiguration ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AutoPauseHasBeenSet()

bool Aws::RDS::Model::ScalingConfiguration::AutoPauseHasBeenSet ( ) const
inline

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

Definition at line 162 of file ScalingConfiguration.h.

◆ GetAutoPause()

bool Aws::RDS::Model::ScalingConfiguration::GetAutoPause ( ) const
inline

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

Definition at line 152 of file ScalingConfiguration.h.

◆ GetMaxCapacity()

int Aws::RDS::Model::ScalingConfiguration::GetMaxCapacity ( ) const
inline

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

Definition at line 105 of file ScalingConfiguration.h.

◆ GetMinCapacity()

int Aws::RDS::Model::ScalingConfiguration::GetMinCapacity ( ) const
inline

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

Definition at line 56 of file ScalingConfiguration.h.

◆ GetSecondsUntilAutoPause()

int Aws::RDS::Model::ScalingConfiguration::GetSecondsUntilAutoPause ( ) const
inline

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Definition at line 189 of file ScalingConfiguration.h.

◆ GetTimeoutAction()

const Aws::String& Aws::RDS::Model::ScalingConfiguration::GetTimeoutAction ( ) const
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 224 of file ScalingConfiguration.h.

◆ MaxCapacityHasBeenSet()

bool Aws::RDS::Model::ScalingConfiguration::MaxCapacityHasBeenSet ( ) const
inline

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

Definition at line 117 of file ScalingConfiguration.h.

◆ MinCapacityHasBeenSet()

bool Aws::RDS::Model::ScalingConfiguration::MinCapacityHasBeenSet ( ) const
inline

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

Definition at line 68 of file ScalingConfiguration.h.

◆ operator=()

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

void Aws::RDS::Model::ScalingConfiguration::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SecondsUntilAutoPauseHasBeenSet()

bool Aws::RDS::Model::ScalingConfiguration::SecondsUntilAutoPauseHasBeenSet ( ) const
inline

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Definition at line 195 of file ScalingConfiguration.h.

◆ SetAutoPause()

void Aws::RDS::Model::ScalingConfiguration::SetAutoPause ( bool  value)
inline

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

Definition at line 172 of file ScalingConfiguration.h.

◆ SetMaxCapacity()

void Aws::RDS::Model::ScalingConfiguration::SetMaxCapacity ( int  value)
inline

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

Definition at line 129 of file ScalingConfiguration.h.

◆ SetMinCapacity()

void Aws::RDS::Model::ScalingConfiguration::SetMinCapacity ( int  value)
inline

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

Definition at line 80 of file ScalingConfiguration.h.

◆ SetSecondsUntilAutoPause()

void Aws::RDS::Model::ScalingConfiguration::SetSecondsUntilAutoPause ( int  value)
inline

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Definition at line 201 of file ScalingConfiguration.h.

◆ SetTimeoutAction() [1/3]

void Aws::RDS::Model::ScalingConfiguration::SetTimeoutAction ( const Aws::String value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 256 of file ScalingConfiguration.h.

◆ SetTimeoutAction() [2/3]

void Aws::RDS::Model::ScalingConfiguration::SetTimeoutAction ( Aws::String &&  value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 272 of file ScalingConfiguration.h.

◆ SetTimeoutAction() [3/3]

void Aws::RDS::Model::ScalingConfiguration::SetTimeoutAction ( const char *  value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 288 of file ScalingConfiguration.h.

◆ TimeoutActionHasBeenSet()

bool Aws::RDS::Model::ScalingConfiguration::TimeoutActionHasBeenSet ( ) const
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 240 of file ScalingConfiguration.h.

◆ WithAutoPause()

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithAutoPause ( bool  value)
inline

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

Definition at line 182 of file ScalingConfiguration.h.

◆ WithMaxCapacity()

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithMaxCapacity ( int  value)
inline

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

Definition at line 141 of file ScalingConfiguration.h.

◆ WithMinCapacity()

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithMinCapacity ( int  value)
inline

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

Definition at line 92 of file ScalingConfiguration.h.

◆ WithSecondsUntilAutoPause()

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithSecondsUntilAutoPause ( int  value)
inline

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Definition at line 207 of file ScalingConfiguration.h.

◆ WithTimeoutAction() [1/3]

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithTimeoutAction ( const Aws::String value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 304 of file ScalingConfiguration.h.

◆ WithTimeoutAction() [2/3]

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithTimeoutAction ( Aws::String &&  value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 320 of file ScalingConfiguration.h.

◆ WithTimeoutAction() [3/3]

ScalingConfiguration& Aws::RDS::Model::ScalingConfiguration::WithTimeoutAction ( const char *  value)
inline

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 336 of file ScalingConfiguration.h.


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