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::ReplicaGlobalSecondaryIndexSettingsUpdate

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

{
  index_name: "IndexName", # required
  provisioned_read_capacity_units: 1,
  provisioned_read_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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

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

Returns:

  • (String)


6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6549

class ReplicaGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_read_capacity_auto_scaling_settings_updateTypes::AutoScalingSettingsUpdate

Auto scaling settings for managing a global secondary index replica's read capacity units.



6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6549

class ReplicaGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_read_capacity_unitsInteger

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Returns:

  • (Integer)


6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6549

class ReplicaGlobalSecondaryIndexSettingsUpdate < Struct.new(
  :index_name,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings_update)
  SENSITIVE = []
  include Aws::Structure
end