Class: Aws::RDS::Types::ScalingConfiguration

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 ScalingConfiguration data as a hash:

{
  min_capacity: 1,
  max_capacity: 1,
  auto_pause: false,
  seconds_until_auto_pause: 1,
  timeout_action: "String",
  seconds_before_timeout: 1,
}

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see [Using Amazon Aurora Serverless] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_pauseBoolean

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

<note markdown=“1”> 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.

</note>

Returns:

  • (Boolean)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacityInteger

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.

Returns:

  • (Integer)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#min_capacityInteger

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.

Returns:

  • (Integer)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  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 60 and 600 seconds.

Returns:

  • (Integer)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#seconds_until_auto_pauseInteger

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

Specify a value between 300 and 86,400 seconds.

Returns:

  • (Integer)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_actionString

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

For more information, see [ Autoscaling for Aurora Serverless] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling

Returns:

  • (String)

22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
# File 'lib/aws-sdk-rds/types.rb', line 22680

class ScalingConfiguration < Struct.new(
  :min_capacity,
  :max_capacity,
  :auto_pause,
  :seconds_until_auto_pause,
  :timeout_action,
  :seconds_before_timeout)
  SENSITIVE = []
  include Aws::Structure
end