AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DynamoDB::Types::AutoScalingSettingsUpdate

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

{
  minimum_units: 1,
  maximum_units: 1,
  auto_scaling_disabled: false,
  auto_scaling_role_arn: "AutoScalingRoleArn",
  scaling_policy_update: {
    policy_name: "AutoScalingPolicyName",
    target_tracking_scaling_policy_configuration: { # required
      disable_scale_in: false,
      scale_in_cooldown: 1,
      scale_out_cooldown: 1,
      target_value: 1.0, # required
    },
  },
}

Represents the auto scaling settings to be modified for a global table or global secondary index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_disabledBoolean

Disabled auto scaling for this global table or global secondary index.

Returns:

  • (Boolean)


459
460
461
462
463
464
465
466
467
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 459

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

#auto_scaling_role_arnString

Role ARN used for configuring auto scaling policy.

Returns:

  • (String)


459
460
461
462
463
464
465
466
467
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 459

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

#maximum_unitsInteger

The maximum capacity units that a global table or global secondary index should be scaled up to.

Returns:

  • (Integer)


459
460
461
462
463
464
465
466
467
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 459

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

#minimum_unitsInteger

The minimum capacity units that a global table or global secondary index should be scaled down to.

Returns:

  • (Integer)


459
460
461
462
463
464
465
466
467
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 459

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

#scaling_policy_updateTypes::AutoScalingPolicyUpdate

The scaling policy to apply for scaling target global table or global secondary index capacity units.



459
460
461
462
463
464
465
466
467
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 459

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