Struct aws_sdk_dynamodb::types::LocalSecondaryIndexDescription

#[non_exhaustive]
pub struct LocalSecondaryIndexDescription {
    pub index_name: Option<String>,
    pub key_schema: Option<Vec<KeySchemaElement>>,
    pub projection: Option<Projection>,
    pub index_size_bytes: Option<i64>,
    pub item_count: Option<i64>,
    pub index_arn: Option<String>,
}

Represents the properties of a local 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>

Represents the name of the local secondary index.

key_schema: Option<Vec<KeySchemaElement>>

The complete key schema for the local secondary index, consisting 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_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.

Implementations

impl LocalSecondaryIndexDescription

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

Represents the name of the local secondary index.

pub fn key_schema(&self) -> &[KeySchemaElement]

The complete key schema for the local secondary index, consisting 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_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.

impl LocalSecondaryIndexDescription

pub fn builder() -> LocalSecondaryIndexDescriptionBuilder

Creates a new builder-style object to manufacture LocalSecondaryIndexDescription.

Trait Implementations

impl Clone for LocalSecondaryIndexDescription

fn clone(&self) -> LocalSecondaryIndexDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalSecondaryIndexDescription

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

Formats the value using the given formatter.

impl PartialEq for LocalSecondaryIndexDescription

fn eq(&self, other: &LocalSecondaryIndexDescription) -> 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 LocalSecondaryIndexDescription