Struct aws_sdk_dynamodb::types::GlobalSecondaryIndexInfo
source · #[non_exhaustive]pub struct GlobalSecondaryIndexInfo {
pub index_name: Option<String>,
pub key_schema: Option<Vec<KeySchemaElement>>,
pub projection: Option<Projection>,
pub provisioned_throughput: Option<ProvisionedThroughput>,
}
Expand description
Represents the properties of a global secondary index for the table when the backup was created.
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>
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.
provisioned_throughput: Option<ProvisionedThroughput>
Represents the provisioned throughput settings for the specified global secondary index.
Implementations§
source§impl GlobalSecondaryIndexInfo
impl GlobalSecondaryIndexInfo
sourcepub fn index_name(&self) -> Option<&str>
pub fn index_name(&self) -> Option<&str>
The name of the global secondary index.
sourcepub fn key_schema(&self) -> Option<&[KeySchemaElement]>
pub fn key_schema(&self) -> Option<&[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.
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 provisioned_throughput(&self) -> Option<&ProvisionedThroughput>
pub fn provisioned_throughput(&self) -> Option<&ProvisionedThroughput>
Represents the provisioned throughput settings for the specified global secondary index.
source§impl GlobalSecondaryIndexInfo
impl GlobalSecondaryIndexInfo
sourcepub fn builder() -> GlobalSecondaryIndexInfoBuilder
pub fn builder() -> GlobalSecondaryIndexInfoBuilder
Creates a new builder-style object to manufacture GlobalSecondaryIndexInfo
.
Trait Implementations§
source§impl Clone for GlobalSecondaryIndexInfo
impl Clone for GlobalSecondaryIndexInfo
source§fn clone(&self) -> GlobalSecondaryIndexInfo
fn clone(&self) -> GlobalSecondaryIndexInfo
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GlobalSecondaryIndexInfo
impl Debug for GlobalSecondaryIndexInfo
source§impl PartialEq<GlobalSecondaryIndexInfo> for GlobalSecondaryIndexInfo
impl PartialEq<GlobalSecondaryIndexInfo> for GlobalSecondaryIndexInfo
source§fn eq(&self, other: &GlobalSecondaryIndexInfo) -> bool
fn eq(&self, other: &GlobalSecondaryIndexInfo) -> bool
self
and other
values to be equal, and is used
by ==
.