Amazonka.RDS.Types.ScalingConfigurationInfo

Documentation

data ScalingConfigurationInfo

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

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

See: newScalingConfigurationInfo smart constructor.

Constructors

ScalingConfigurationInfo'

Fields

• autoPause :: Maybe Bool

  A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

  When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

• maxCapacity :: Maybe Int

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

• minCapacity :: Maybe Int

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

• secondsBeforeTimeout :: Maybe Int

  The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

• secondsUntilAutoPause :: Maybe Int

  The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

• timeoutAction :: Maybe Text

  The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

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

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

Instances

FromXML ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

parseXML :: [Node] -> Either String ScalingConfigurationInfo

Generic ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Associated Types

type Rep ScalingConfigurationInfo :: Type -> Type

Methods

from :: ScalingConfigurationInfo -> Rep ScalingConfigurationInfo x

to :: Rep ScalingConfigurationInfo x -> ScalingConfigurationInfo

Read ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

readsPrec :: Int -> ReadS ScalingConfigurationInfo

readList :: ReadS [ScalingConfigurationInfo]

readPrec :: ReadPrec ScalingConfigurationInfo

readListPrec :: ReadPrec [ScalingConfigurationInfo]

Show ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

showsPrec :: Int -> ScalingConfigurationInfo -> ShowS

show :: ScalingConfigurationInfo -> String

showList :: [ScalingConfigurationInfo] -> ShowS

NFData ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

rnf :: ScalingConfigurationInfo -> ()

Eq ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

(==) :: ScalingConfigurationInfo -> ScalingConfigurationInfo -> Bool

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

Hashable ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Methods

hashWithSalt :: Int -> ScalingConfigurationInfo -> Int

hash :: ScalingConfigurationInfo -> Int

type Rep ScalingConfigurationInfo

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

type Rep ScalingConfigurationInfo = D1 ('MetaData "ScalingConfigurationInfo" "Amazonka.RDS.Types.ScalingConfigurationInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ScalingConfigurationInfo'" '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))))))

newScalingConfigurationInfo :: ScalingConfigurationInfo

Create a value of ScalingConfigurationInfo 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:ScalingConfigurationInfo', scalingConfigurationInfo_autoPause - A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

$sel:maxCapacity:ScalingConfigurationInfo', scalingConfigurationInfo_maxCapacity - The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

$sel:minCapacity:ScalingConfigurationInfo', scalingConfigurationInfo_minCapacity - The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

$sel:secondsBeforeTimeout:ScalingConfigurationInfo', scalingConfigurationInfo_secondsBeforeTimeout - The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

$sel:secondsUntilAutoPause:ScalingConfigurationInfo', scalingConfigurationInfo_secondsUntilAutoPause - The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

$sel:timeoutAction:ScalingConfigurationInfo', scalingConfigurationInfo_timeoutAction - The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

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

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

scalingConfigurationInfo_autoPause :: Lens' ScalingConfigurationInfo (Maybe Bool)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

scalingConfigurationInfo_maxCapacity :: Lens' ScalingConfigurationInfo (Maybe Int)

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

scalingConfigurationInfo_minCapacity :: Lens' ScalingConfigurationInfo (Maybe Int)

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

scalingConfigurationInfo_secondsBeforeTimeout :: Lens' ScalingConfigurationInfo (Maybe Int)

The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

scalingConfigurationInfo_secondsUntilAutoPause :: Lens' ScalingConfigurationInfo (Maybe Int)

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

scalingConfigurationInfo_timeoutAction :: Lens' ScalingConfigurationInfo (Maybe Text)

The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

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

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