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.

See Also:

Instance Attribute Summary collapse

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) 


5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end

#index_status ⇒ String

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) 


5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end

#provisioned_read_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

Autoscaling settings for a global secondary index replica’s read capacity units.

Returns:



5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end

#provisioned_read_capacity_units ⇒ Integer

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

Returns:

  • (Integer) 


5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end

#provisioned_write_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

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

Returns:



5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end

#provisioned_write_capacity_units ⇒ Integer

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

Returns:

  • (Integer) 


5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5443

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)
  include Aws::Structure
end