Class: Aws::Keyspaces::Types::AutoScalingSettings

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

Overview

The optional auto scaling settings for a table with provisioned throughput capacity.

To turn on auto scaling for a table in ‘throughputMode:PROVISIONED`, you must specify the following parameters.

Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.

  • ‘minimumUnits`: The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

  • ‘maximumUnits`: The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

  • ‘scalingPolicy`: Amazon Keyspaces supports the `target tracking` scaling policy. The auto scaling target is the provisioned capacity of the table.

    • ‘targetTrackingScalingPolicyConfiguration`: To define the target tracking policy, you must define the target value.

      • ‘targetValue`: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define `targetValue` as a percentage. A `double` between 20 and 90. (Required)

      • ‘disableScaleIn`: A `boolean` that specifies if `scale-in` is disabled or enabled for the table. This parameter is disabled by default. To turn on `scale-in`, set the `boolean` value to `FALSE`. This means that capacity for a table can be automatically scaled down on your behalf. (Optional)

      • ‘scaleInCooldown`: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)

      • ‘scaleOutCooldown`: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)

For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling] in the *Amazon Keyspaces Developer Guide*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_disabled ⇒ Boolean

This optional parameter enables auto scaling for the table if set to ‘false`.

Returns:

  • (Boolean) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 129

class AutoScalingSettings < Struct.new(
  :auto_scaling_disabled,
  :minimum_units,
  :maximum_units,
  :scaling_policy)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_units ⇒ Integer

Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

  • (Integer) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 129

class AutoScalingSettings < Struct.new(
  :auto_scaling_disabled,
  :minimum_units,
  :maximum_units,
  :scaling_policy)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_units ⇒ Integer

The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

  • (Integer) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 129

class AutoScalingSettings < Struct.new(
  :auto_scaling_disabled,
  :minimum_units,
  :maximum_units,
  :scaling_policy)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_policy ⇒ Types::AutoScalingPolicy

Amazon Keyspaces supports the ‘target tracking` auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Returns:



129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 129

class AutoScalingSettings < Struct.new(
  :auto_scaling_disabled,
  :minimum_units,
  :maximum_units,
  :scaling_policy)
  SENSITIVE = []
  include Aws::Structure
end