Struct aws_sdk_dynamodb::types::GlobalSecondaryIndexDescription

#[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: Option<i64>,
    pub item_count: Option<i64>,
    pub index_arn: Option<String>,
    pub on_demand_throughput: Option<OnDemandThroughput>,
}

Represents the properties of a global secondary index.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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: 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.

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.

index_arn: Option<String>

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

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

Implementations

impl GlobalSecondaryIndexDescription

pub fn index_name(&self) -> Option<&str>

The name of the global secondary index.

pub fn key_schema(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .key_schema.is_none().

pub fn projection(&self) -> 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.

pub fn index_status(&self) -> 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.

pub fn backfilling(&self) -> 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.

pub fn provisioned_throughput( &self, ) -> 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.

pub fn index_size_bytes(&self) -> 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.

pub fn item_count(&self) -> 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.

pub fn index_arn(&self) -> Option<&str>

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

pub fn on_demand_throughput(&self) -> Option<&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.

impl GlobalSecondaryIndexDescription

pub fn builder() -> GlobalSecondaryIndexDescriptionBuilder

Creates a new builder-style object to manufacture GlobalSecondaryIndexDescription.

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 PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GlobalSecondaryIndexDescription