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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/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)


7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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)


7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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.



7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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)


7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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.



7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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)


7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7214

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