You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DynamoDB::Types::AutoScalingTargetTrackingScalingPolicyConfigurationUpdate

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

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

{
  disable_scale_in: false,
  scale_in_cooldown: 1,
  scale_out_cooldown: 1,
  target_value: 1.0, # required
}

Represents the settings of a target tracking scaling policy that will be modified.

Instance Attribute Summary collapse

Instance Attribute Details

#disable_scale_inBoolean

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Returns:

  • (Boolean)


518
519
520
521
522
523
524
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 518

class AutoScalingTargetTrackingScalingPolicyConfigurationUpdate < Struct.new(
  :disable_scale_in,
  :scale_in_cooldown,
  :scale_out_cooldown,
  :target_value)
  include Aws::Structure
end

#scale_in_cooldownInteger

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

Returns:

  • (Integer)


518
519
520
521
522
523
524
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 518

class AutoScalingTargetTrackingScalingPolicyConfigurationUpdate < Struct.new(
  :disable_scale_in,
  :scale_in_cooldown,
  :scale_out_cooldown,
  :target_value)
  include Aws::Structure
end

#scale_out_cooldownInteger

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

Returns:

  • (Integer)


518
519
520
521
522
523
524
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 518

class AutoScalingTargetTrackingScalingPolicyConfigurationUpdate < Struct.new(
  :disable_scale_in,
  :scale_in_cooldown,
  :scale_out_cooldown,
  :target_value)
  include Aws::Structure
end

#target_valueFloat

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

  • (Float)


518
519
520
521
522
523
524
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 518

class AutoScalingTargetTrackingScalingPolicyConfigurationUpdate < Struct.new(
  :disable_scale_in,
  :scale_in_cooldown,
  :scale_out_cooldown,
  :target_value)
  include Aws::Structure
end