Amazonka.RDS.Types.ScalingConfiguration

Documentation

data ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

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

See: newScalingConfiguration smart constructor.

Constructors

ScalingConfiguration'

Fields

• autoPause :: Maybe Bool

  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.

• maxCapacity :: Maybe Int

  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.

• minCapacity :: Maybe Int

  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.

• secondsBeforeTimeout :: Maybe Int

  The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

  Specify a value between 60 and 600 seconds.

• secondsUntilAutoPause :: Maybe Int

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

  Specify a value between 300 and 86,400 seconds.

• timeoutAction :: Maybe Text

  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 v1 from finding a scaling point might be dropped.

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

Instances

ToQuery ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

toQuery :: ScalingConfiguration -> QueryString

Generic ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Associated Types

type Rep ScalingConfiguration :: Type -> Type

Methods

from :: ScalingConfiguration -> Rep ScalingConfiguration x

to :: Rep ScalingConfiguration x -> ScalingConfiguration

Read ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

readsPrec :: Int -> ReadS ScalingConfiguration

readList :: ReadS [ScalingConfiguration]

readPrec :: ReadPrec ScalingConfiguration

readListPrec :: ReadPrec [ScalingConfiguration]

Show ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

showsPrec :: Int -> ScalingConfiguration -> ShowS

show :: ScalingConfiguration -> String

showList :: [ScalingConfiguration] -> ShowS

NFData ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

rnf :: ScalingConfiguration -> ()

Eq ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

(==) :: ScalingConfiguration -> ScalingConfiguration -> Bool

(/=) :: ScalingConfiguration -> ScalingConfiguration -> Bool

Hashable ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

hashWithSalt :: Int -> ScalingConfiguration -> Int

hash :: ScalingConfiguration -> Int

type Rep ScalingConfiguration

Defined in Amazonka.RDS.Types.ScalingConfiguration

type Rep ScalingConfiguration = D1 ('MetaData "ScalingConfiguration" "Amazonka.RDS.Types.ScalingConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ScalingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "secondsUntilAutoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newScalingConfiguration :: ScalingConfiguration

Create a value of ScalingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoPause:ScalingConfiguration', scalingConfiguration_autoPause - 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.

$sel:maxCapacity:ScalingConfiguration', scalingConfiguration_maxCapacity - 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.

$sel:minCapacity:ScalingConfiguration', scalingConfiguration_minCapacity - 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.

$sel:secondsBeforeTimeout:ScalingConfiguration', scalingConfiguration_secondsBeforeTimeout - The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

$sel:secondsUntilAutoPause:ScalingConfiguration', scalingConfiguration_secondsUntilAutoPause - The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

$sel:timeoutAction:ScalingConfiguration', scalingConfiguration_timeoutAction - 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 v1 from finding a scaling point might be dropped.

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

scalingConfiguration_autoPause :: Lens' ScalingConfiguration (Maybe Bool)

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.

scalingConfiguration_maxCapacity :: Lens' ScalingConfiguration (Maybe Int)

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.

scalingConfiguration_minCapacity :: Lens' ScalingConfiguration (Maybe Int)

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.

scalingConfiguration_secondsBeforeTimeout :: Lens' ScalingConfiguration (Maybe Int)

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

scalingConfiguration_secondsUntilAutoPause :: Lens' ScalingConfiguration (Maybe Int)

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

Specify a value between 300 and 86,400 seconds.

scalingConfiguration_timeoutAction :: Lens' ScalingConfiguration (Maybe Text)

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 v1 from finding a scaling point might be dropped.

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