#[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>,
}
Expand description
Represents the properties of a local 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>
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§
source§impl LocalSecondaryIndexDescription
impl LocalSecondaryIndexDescription
sourcepub fn index_name(&self) -> Option<&str>
pub fn index_name(&self) -> Option<&str>
Represents the name of the local secondary index.
sourcepub fn key_schema(&self) -> &[KeySchemaElement]
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()
.
sourcepub fn projection(&self) -> Option<&Projection>
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.
sourcepub fn index_size_bytes(&self) -> Option<i64>
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.
sourcepub fn item_count(&self) -> Option<i64>
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.
source§impl LocalSecondaryIndexDescription
impl LocalSecondaryIndexDescription
sourcepub fn builder() -> LocalSecondaryIndexDescriptionBuilder
pub fn builder() -> LocalSecondaryIndexDescriptionBuilder
Creates a new builder-style object to manufacture LocalSecondaryIndexDescription
.
Trait Implementations§
source§impl Clone for LocalSecondaryIndexDescription
impl Clone for LocalSecondaryIndexDescription
source§fn clone(&self) -> LocalSecondaryIndexDescription
fn clone(&self) -> LocalSecondaryIndexDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for LocalSecondaryIndexDescription
impl PartialEq for LocalSecondaryIndexDescription
source§fn eq(&self, other: &LocalSecondaryIndexDescription) -> bool
fn eq(&self, other: &LocalSecondaryIndexDescription) -> bool
self
and other
values to be equal, and is used
by ==
.