Struct rusoto_dynamodb::GlobalSecondaryIndexDescription

pub struct GlobalSecondaryIndexDescription {
    pub backfilling: Option<bool>,
    pub index_arn: Option<String>,
    pub index_name: Option<String>,
    pub index_size_bytes: Option<i64>,
    pub index_status: Option<String>,
    pub item_count: Option<i64>,
    pub key_schema: Option<Vec<KeySchemaElement>>,
    pub projection: Option<Projection>,
    pub provisioned_throughput: Option<ProvisionedThroughputDescription>,
}

Represents the properties of a global secondary index.

Fields

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.

index_arn: Option<String>

The Amazon Resource Name (ARN) that uniquely identifies the index.

index_name: Option<String>

The name of the global secondary index.

index_size_bytes: Option<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.

index_status: Option<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.

item_count: Option<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.

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.

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.

Trait Implementations

impl Clone for GlobalSecondaryIndexDescription

fn clone(&self) -> GlobalSecondaryIndexDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GlobalSecondaryIndexDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GlobalSecondaryIndexDescription

fn default() -> GlobalSecondaryIndexDescription

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalSecondaryIndexDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<GlobalSecondaryIndexDescription> for GlobalSecondaryIndexDescription

fn eq(&self, other: &GlobalSecondaryIndexDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GlobalSecondaryIndexDescription) -> bool

This method tests for !=.

impl StructuralPartialEq for GlobalSecondaryIndexDescription