Class: Aws::DynamoDB::Types::ReplicaGlobalSecondaryIndexSettingsDescription

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

Overview

Represents the properties of a global secondary index.

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)

7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  SENSITIVE = []
  include Aws::Structure
end

#index_statusString

The current status of the global secondary index:

  • `CREATING` - The global secondary index is being created.

  • `UPDATING` - The global secondary index is being updated.

  • `DELETING` - The global secondary index is being deleted.

  • `ACTIVE` - The global secondary index is ready for use.

Returns:

  • (String)

7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_read_capacity_auto_scaling_settingsTypes::AutoScalingSettingsDescription

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


7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  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)

7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_write_capacity_auto_scaling_settingsTypes::AutoScalingSettingsDescription

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


7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_write_capacity_unitsInteger

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

Returns:

  • (Integer)

7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'lib/aws-sdk-dynamodb/types.rb', line 7239

class ReplicaGlobalSecondaryIndexSettingsDescription < Struct.new(
  :index_name,
  :index_status,
  :provisioned_read_capacity_units,
  :provisioned_read_capacity_auto_scaling_settings,
  :provisioned_write_capacity_units,
  :provisioned_write_capacity_auto_scaling_settings)
  SENSITIVE = []
  include Aws::Structure
end