Class: Aws::RDS::Types::ModifyCurrentDBClusterCapacityMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass ModifyCurrentDBClusterCapacityMessage data as a hash:

{
  db_cluster_identifier: "String", # required
  capacity: 1,
  seconds_before_timeout: 1,
  timeout_action: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacityInteger

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`.

Returns:

  • (Integer)

13576
13577
13578
13579
13580
13581
13582
13583
# File 'lib/aws-sdk-rds/types.rb', line 13576

class ModifyCurrentDBClusterCapacityMessage < Struct.new(
  :db_cluster_identifier,
  :capacity,
  :seconds_before_timeout,
  :timeout_action)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifierString

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.

^

Returns:

  • (String)

13576
13577
13578
13579
13580
13581
13582
13583
# File 'lib/aws-sdk-rds/types.rb', line 13576

class ModifyCurrentDBClusterCapacityMessage < Struct.new(
  :db_cluster_identifier,
  :capacity,
  :seconds_before_timeout,
  :timeout_action)
  SENSITIVE = []
  include Aws::Structure
end

#seconds_before_timeoutInteger

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.

Returns:

  • (Integer)

13576
13577
13578
13579
13580
13581
13582
13583
# File 'lib/aws-sdk-rds/types.rb', line 13576

class ModifyCurrentDBClusterCapacityMessage < Struct.new(
  :db_cluster_identifier,
  :capacity,
  :seconds_before_timeout,
  :timeout_action)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_actionString

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.

Returns:

  • (String)

13576
13577
13578
13579
13580
13581
13582
13583
# File 'lib/aws-sdk-rds/types.rb', line 13576

class ModifyCurrentDBClusterCapacityMessage < Struct.new(
  :db_cluster_identifier,
  :capacity,
  :seconds_before_timeout,
  :timeout_action)
  SENSITIVE = []
  include Aws::Structure
end