Class: Aws::DynamoDB::Types::GlobalSecondaryIndexDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::GlobalSecondaryIndexDescription
- 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
-
#backfilling ⇒ Boolean
Indicates whether the index is currently backfilling.
-
#index_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the index.
-
#index_name ⇒ String
The name of the global secondary index.
-
#index_size_bytes ⇒ Integer
The total size of the specified index, in bytes.
-
#index_status ⇒ String
The current state of the global secondary index:.
-
#item_count ⇒ Integer
The number of items in the specified index.
-
#key_schema ⇒ Array<Types::KeySchemaElement>
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:.
-
#on_demand_throughput ⇒ Types::OnDemandThroughput
The maximum number of read and write units for the specified global secondary index.
-
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into the global secondary index.
-
#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription
Represents the provisioned throughput settings for the specified global secondary index.
Instance Attribute Details
#backfilling ⇒ Boolean
Indicates whether the index is currently backfilling. Backfilling
is the process of reading items from the table and determining
whether they can be added to the index. (Not all items will qualify:
For example, a partition key cannot have any duplicate values.) If
an item can be added to the index, DynamoDB will do so. After all
items have been processed, the backfilling operation is complete and
Backfilling
is false.
You can delete an index that is being created during the
Backfilling
phase when IndexStatus
is set to CREATING and
Backfilling
is true. You can't delete the index that is being
created when IndexStatus
is set to CREATING and Backfilling
is
false.
CreateTable
operation, the
Backfilling
attribute does not appear in the DescribeTable
output.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#index_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the index.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#index_name ⇒ String
The name of the global secondary index.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#index_size_bytes ⇒ Integer
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#index_status ⇒ String
The current state of the global secondary index:
CREATING
- The index is being created.UPDATING
- The index is being updated.DELETING
- The index is being deleted.ACTIVE
- The index is ready for use.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#item_count ⇒ Integer
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#key_schema ⇒ Array<Types::KeySchemaElement>
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#on_demand_throughput ⇒ Types::OnDemandThroughput
The maximum number of read and write units for the specified global
secondary index. If you use this parameter, you must specify
MaxReadRequestUnits
, MaxWriteRequestUnits
, or both.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |
#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4266 class GlobalSecondaryIndexDescription < Struct.new( :index_name, :key_schema, :projection, :index_status, :backfilling, :provisioned_throughput, :index_size_bytes, :item_count, :index_arn, :on_demand_throughput) SENSITIVE = [] include Aws::Structure end |