Struct aws_sdk_dynamodb::types::LocalSecondaryIndex

#[non_exhaustive]
pub struct LocalSecondaryIndex {
    pub index_name: String,
    pub key_schema: Vec<KeySchemaElement>,
    pub projection: Option<Projection>,
}

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: String

The name of the local secondary index. The name must be unique among all other indexes on this table.

key_schema: 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 local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Implementations

impl LocalSecondaryIndex

pub fn index_name(&self) -> &str

The name of the local secondary index. The name must be unique among all other indexes on this table.

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.

pub fn projection(&self) -> Option<&Projection>

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

impl LocalSecondaryIndex

pub fn builder() -> LocalSecondaryIndexBuilder

Creates a new builder-style object to manufacture LocalSecondaryIndex.

Trait Implementations

impl Clone for LocalSecondaryIndex

fn clone(&self) -> LocalSecondaryIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalSecondaryIndex

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

Formats the value using the given formatter.

impl PartialEq for LocalSecondaryIndex

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