Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.ModifyCurrentDBClusterCapacity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

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

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

This action only applies to Aurora Serverless v1 DB clusters.

Synopsis

Creating a Request

data ModifyCurrentDBClusterCapacity Source #

See: newModifyCurrentDBClusterCapacity smart constructor.

Constructors

ModifyCurrentDBClusterCapacity'

Fields

capacity :: Maybe Int
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
- 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.
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 10 and 600 seconds.
timeoutAction :: Maybe Text
The action to take when the timeout is reached, 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.
dbClusterIdentifier :: Text
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DB cluster.

Instances

Instances details

ToHeaders ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods toHeaders :: ModifyCurrentDBClusterCapacity -> [Header] #
ToPath ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods toPath :: ModifyCurrentDBClusterCapacity -> ByteString #
ToQuery ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods toQuery :: ModifyCurrentDBClusterCapacity -> QueryString #
AWSRequest ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Associated Types type AWSResponse ModifyCurrentDBClusterCapacity # Methods request :: (Service -> Service) -> ModifyCurrentDBClusterCapacity -> Request ModifyCurrentDBClusterCapacity # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyCurrentDBClusterCapacity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyCurrentDBClusterCapacity))) #
Generic ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Associated Types type Rep ModifyCurrentDBClusterCapacity :: Type -> Type # Methods from :: ModifyCurrentDBClusterCapacity -> Rep ModifyCurrentDBClusterCapacity x # to :: Rep ModifyCurrentDBClusterCapacity x -> ModifyCurrentDBClusterCapacity #
Read ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods readsPrec :: Int -> ReadS ModifyCurrentDBClusterCapacity # readList :: ReadS [ModifyCurrentDBClusterCapacity] # readPrec :: ReadPrec ModifyCurrentDBClusterCapacity # readListPrec :: ReadPrec [ModifyCurrentDBClusterCapacity] #
Show ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods showsPrec :: Int -> ModifyCurrentDBClusterCapacity -> ShowS # show :: ModifyCurrentDBClusterCapacity -> String # showList :: [ModifyCurrentDBClusterCapacity] -> ShowS #
NFData ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods rnf :: ModifyCurrentDBClusterCapacity -> () #
Eq ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods (==) :: ModifyCurrentDBClusterCapacity -> ModifyCurrentDBClusterCapacity -> Bool # (/=) :: ModifyCurrentDBClusterCapacity -> ModifyCurrentDBClusterCapacity -> Bool #
Hashable ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods hashWithSalt :: Int -> ModifyCurrentDBClusterCapacity -> Int # hash :: ModifyCurrentDBClusterCapacity -> Int #
type AWSResponse ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type AWSResponse ModifyCurrentDBClusterCapacity = ModifyCurrentDBClusterCapacityResponse
type Rep ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type Rep ModifyCurrentDBClusterCapacity = D1 ('MetaData "ModifyCurrentDBClusterCapacity" "Amazonka.RDS.ModifyCurrentDBClusterCapacity" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyCurrentDBClusterCapacity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyCurrentDBClusterCapacity Source #

Arguments

:: Text	`ModifyCurrentDBClusterCapacity`
-> ModifyCurrentDBClusterCapacity

Create a value of ModifyCurrentDBClusterCapacity 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:

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacity_capacity - The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

Constraints:

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.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacity_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 10 and 600 seconds.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacity_timeoutAction - The action to take when the timeout is reached, 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.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacity_dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster.

Request Lenses

modifyCurrentDBClusterCapacity_capacity :: Lens' ModifyCurrentDBClusterCapacity (Maybe Int) Source #

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

Constraints:

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.

modifyCurrentDBClusterCapacity_secondsBeforeTimeout :: Lens' ModifyCurrentDBClusterCapacity (Maybe Int) Source #

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 10 and 600 seconds.

modifyCurrentDBClusterCapacity_timeoutAction :: Lens' ModifyCurrentDBClusterCapacity (Maybe Text) Source #

The action to take when the timeout is reached, 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.

modifyCurrentDBClusterCapacity_dbClusterIdentifier :: Lens' ModifyCurrentDBClusterCapacity Text Source #

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster.

Destructuring the Response

data ModifyCurrentDBClusterCapacityResponse Source #

See: newModifyCurrentDBClusterCapacityResponse smart constructor.

Constructors

ModifyCurrentDBClusterCapacityResponse'

Fields

currentCapacity :: Maybe Int
The current capacity of the DB cluster.
dbClusterIdentifier :: Maybe Text
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
pendingCapacity :: Maybe Int
A value that specifies the capacity that the DB cluster scales to next.
secondsBeforeTimeout :: Maybe Int
The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
timeoutAction :: Maybe Text
The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Associated Types type Rep ModifyCurrentDBClusterCapacityResponse :: Type -> Type # Methods from :: ModifyCurrentDBClusterCapacityResponse -> Rep ModifyCurrentDBClusterCapacityResponse x # to :: Rep ModifyCurrentDBClusterCapacityResponse x -> ModifyCurrentDBClusterCapacityResponse #
Read ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods readsPrec :: Int -> ReadS ModifyCurrentDBClusterCapacityResponse # readList :: ReadS [ModifyCurrentDBClusterCapacityResponse] # readPrec :: ReadPrec ModifyCurrentDBClusterCapacityResponse # readListPrec :: ReadPrec [ModifyCurrentDBClusterCapacityResponse] #
Show ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods showsPrec :: Int -> ModifyCurrentDBClusterCapacityResponse -> ShowS # show :: ModifyCurrentDBClusterCapacityResponse -> String # showList :: [ModifyCurrentDBClusterCapacityResponse] -> ShowS #
NFData ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods rnf :: ModifyCurrentDBClusterCapacityResponse -> () #
Eq ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods (==) :: ModifyCurrentDBClusterCapacityResponse -> ModifyCurrentDBClusterCapacityResponse -> Bool # (/=) :: ModifyCurrentDBClusterCapacityResponse -> ModifyCurrentDBClusterCapacityResponse -> Bool #
type Rep ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type Rep ModifyCurrentDBClusterCapacityResponse = D1 ('MetaData "ModifyCurrentDBClusterCapacityResponse" "Amazonka.RDS.ModifyCurrentDBClusterCapacity" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyCurrentDBClusterCapacityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pendingCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newModifyCurrentDBClusterCapacityResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyCurrentDBClusterCapacityResponse'`
-> ModifyCurrentDBClusterCapacityResponse

Create a value of ModifyCurrentDBClusterCapacityResponse 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:currentCapacity:ModifyCurrentDBClusterCapacityResponse', modifyCurrentDBClusterCapacityResponse_currentCapacity - The current capacity of the DB cluster.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacityResponse_dbClusterIdentifier - A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

$sel:pendingCapacity:ModifyCurrentDBClusterCapacityResponse', modifyCurrentDBClusterCapacityResponse_pendingCapacity - A value that specifies the capacity that the DB cluster scales to next.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacityResponse_secondsBeforeTimeout - The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

ModifyCurrentDBClusterCapacity, modifyCurrentDBClusterCapacityResponse_timeoutAction - The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

$sel:httpStatus:ModifyCurrentDBClusterCapacityResponse', modifyCurrentDBClusterCapacityResponse_httpStatus - The response's http status code.

Response Lenses

modifyCurrentDBClusterCapacityResponse_currentCapacity :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

The current capacity of the DB cluster.

modifyCurrentDBClusterCapacityResponse_dbClusterIdentifier :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Text) Source #

A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

modifyCurrentDBClusterCapacityResponse_pendingCapacity :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

A value that specifies the capacity that the DB cluster scales to next.

modifyCurrentDBClusterCapacityResponse_secondsBeforeTimeout :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Int) Source #

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

modifyCurrentDBClusterCapacityResponse_timeoutAction :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Text) Source #

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

modifyCurrentDBClusterCapacityResponse_httpStatus :: Lens' ModifyCurrentDBClusterCapacityResponse Int Source #

The response's http status code.