Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.ModifyCurrentDBClusterCapacity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Aurora Serverless 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 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, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

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

This action only applies to Aurora Serverless DB clusters.

Synopsis

Creating a Request

data ModifyCurrentDBClusterCapacity Source #

See: newModifyCurrentDBClusterCapacity smart constructor.

Constructors

ModifyCurrentDBClusterCapacity'

Fields

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.
capacity :: Maybe Int
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless 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 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.
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

Eq ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods (==) :: ModifyCurrentDBClusterCapacity -> ModifyCurrentDBClusterCapacity -> Bool # (/=) :: ModifyCurrentDBClusterCapacity -> ModifyCurrentDBClusterCapacity -> Bool #
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 #
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 #
NFData ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods rnf :: ModifyCurrentDBClusterCapacity -> () #
Hashable ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods hashWithSalt :: Int -> ModifyCurrentDBClusterCapacity -> Int # hash :: ModifyCurrentDBClusterCapacity -> Int #
AWSRequest ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Associated Types type AWSResponse ModifyCurrentDBClusterCapacity # Methods request :: ModifyCurrentDBClusterCapacity -> Request ModifyCurrentDBClusterCapacity # response :: MonadResource m => Logger -> Service -> Proxy ModifyCurrentDBClusterCapacity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyCurrentDBClusterCapacity))) #
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 #
type Rep ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type Rep ModifyCurrentDBClusterCapacity = D1 ('MetaData "ModifyCurrentDBClusterCapacity" "Amazonka.RDS.ModifyCurrentDBClusterCapacity" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyCurrentDBClusterCapacity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ModifyCurrentDBClusterCapacity Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type AWSResponse ModifyCurrentDBClusterCapacity = ModifyCurrentDBClusterCapacityResponse

newModifyCurrentDBClusterCapacity Source #

Arguments

:: Text	`$sel:dbClusterIdentifier: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:

$sel:timeoutAction: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.

$sel:capacity:ModifyCurrentDBClusterCapacity', modifyCurrentDBClusterCapacity_capacity - The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless 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.

$sel:secondsBeforeTimeout:ModifyCurrentDBClusterCapacity', modifyCurrentDBClusterCapacity_secondsBeforeTimeout - The amount of time, in seconds, that Aurora Serverless 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.

$sel:dbClusterIdentifier: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_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_capacity :: Lens' ModifyCurrentDBClusterCapacity (Maybe Int) Source #

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless 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 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_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

dbClusterIdentifier :: Maybe Text
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
timeoutAction :: Maybe Text
The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
currentCapacity :: Maybe Int
The current capacity of the 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods (==) :: ModifyCurrentDBClusterCapacityResponse -> ModifyCurrentDBClusterCapacityResponse -> Bool # (/=) :: ModifyCurrentDBClusterCapacityResponse -> ModifyCurrentDBClusterCapacityResponse -> Bool #
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 #
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 #
NFData ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity Methods rnf :: ModifyCurrentDBClusterCapacityResponse -> () #
type Rep ModifyCurrentDBClusterCapacityResponse Source #
Instance details Defined in Amazonka.RDS.ModifyCurrentDBClusterCapacity type Rep ModifyCurrentDBClusterCapacityResponse = D1 ('MetaData "ModifyCurrentDBClusterCapacityResponse" "Amazonka.RDS.ModifyCurrentDBClusterCapacity" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyCurrentDBClusterCapacityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "currentCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "pendingCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: 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:dbClusterIdentifier:ModifyCurrentDBClusterCapacity', modifyCurrentDBClusterCapacityResponse_dbClusterIdentifier - A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

$sel:timeoutAction:ModifyCurrentDBClusterCapacity', modifyCurrentDBClusterCapacityResponse_timeoutAction - The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

$sel:currentCapacity:ModifyCurrentDBClusterCapacityResponse', modifyCurrentDBClusterCapacityResponse_currentCapacity - The current capacity of the DB cluster.

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

$sel:secondsBeforeTimeout:ModifyCurrentDBClusterCapacity', modifyCurrentDBClusterCapacityResponse_secondsBeforeTimeout - The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

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

Response Lenses

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_timeoutAction :: Lens' ModifyCurrentDBClusterCapacityResponse (Maybe Text) Source #

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

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

The current capacity of the 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_httpStatus :: Lens' ModifyCurrentDBClusterCapacityResponse Int Source #

The response's http status code.