Struct aws_sdk_dynamodb::model::GlobalSecondaryIndexDescription [−][src]
#[non_exhaustive]pub struct GlobalSecondaryIndexDescription {
pub index_name: Option<String>,
pub key_schema: Option<Vec<KeySchemaElement>>,
pub projection: Option<Projection>,
pub index_status: Option<IndexStatus>,
pub backfilling: Option<bool>,
pub provisioned_throughput: Option<ProvisionedThroughputDescription>,
pub index_size_bytes: i64,
pub item_count: i64,
pub index_arn: Option<String>,
}
Expand description
Represents the properties of a global secondary index.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.index_name: Option<String>
The name of the global secondary index.
key_schema: Option<Vec<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 key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
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.
projection: Option<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.
index_status: Option<IndexStatus>
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.
backfilling: Option<bool>
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.
For indexes that were created during a CreateTable
operation, the Backfilling
attribute does not appear in the DescribeTable
output.
provisioned_throughput: Option<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.
index_size_bytes: i64
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.
item_count: i64
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.
index_arn: Option<String>
The Amazon Resource Name (ARN) that uniquely identifies the index.
Implementations
Creates a new builder-style object to manufacture GlobalSecondaryIndexDescription
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl Send for GlobalSecondaryIndexDescription
impl Sync for GlobalSecondaryIndexDescription
impl Unpin for GlobalSecondaryIndexDescription
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more