Class: Aws::DynamoDB::Types::GlobalTableGlobalSecondaryIndexSettingsUpdate

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::GlobalTableGlobalSecondaryIndexSettingsUpdate

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Note:

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

{
  index_name: "IndexName", # required
  provisioned_write_capacity_units: 1,
  provisioned_write_capacity_auto_scaling_settings_update: {
    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 settings of a global secondary index for a global table that will be modified.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #index_name ⇒ String

  The name of the global secondary index.

• #provisioned_write_capacity_auto_scaling_settings_update ⇒ Types::AutoScalingSettingsUpdate

  AutoScaling settings for managing a global secondary index’s write capacity units.

• #provisioned_write_capacity_units ⇒ Integer

  The maximum number of writes consumed per second before DynamoDB returns a ‘ThrottlingException.`.

Instance Attribute Details

#index_name ⇒ String

The name of the global secondary index. The name must be unique among all other indexes on this table.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3600

class GlobalTableGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings_update)
  include Aws::Structure
end

#provisioned_write_capacity_auto_scaling_settings_update ⇒ Types::AutoScalingSettingsUpdate

AutoScaling settings for managing a global secondary index’s write capacity units.

Returns:

• (Types::AutoScalingSettingsUpdate)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3600

class GlobalTableGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings_update)
  include Aws::Structure
end

#provisioned_write_capacity_units ⇒ Integer

The maximum number of writes consumed per second before DynamoDB returns a ‘ThrottlingException.`

Returns:

• (Integer)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3600

class GlobalTableGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings_update)
  include Aws::Structure
end