Struct aws_sdk_dynamodb::types::GlobalSecondaryIndex
source · #[non_exhaustive]pub struct GlobalSecondaryIndex { /* private fields */ }
Expand description
Represents the properties of a global secondary index.
Implementations§
source§impl GlobalSecondaryIndex
impl GlobalSecondaryIndex
sourcepub fn index_name(&self) -> Option<&str>
pub fn index_name(&self) -> Option<&str>
The name of the global secondary index. The name must be unique among all other indexes on this table.
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.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
source§impl GlobalSecondaryIndex
impl GlobalSecondaryIndex
sourcepub fn builder() -> GlobalSecondaryIndexBuilder
pub fn builder() -> GlobalSecondaryIndexBuilder
Creates a new builder-style object to manufacture GlobalSecondaryIndex
.
Trait Implementations§
source§impl Clone for GlobalSecondaryIndex
impl Clone for GlobalSecondaryIndex
source§fn clone(&self) -> GlobalSecondaryIndex
fn clone(&self) -> GlobalSecondaryIndex
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GlobalSecondaryIndex
impl Debug for GlobalSecondaryIndex
source§impl PartialEq<GlobalSecondaryIndex> for GlobalSecondaryIndex
impl PartialEq<GlobalSecondaryIndex> for GlobalSecondaryIndex
source§fn eq(&self, other: &GlobalSecondaryIndex) -> bool
fn eq(&self, other: &GlobalSecondaryIndex) -> bool
self
and other
values to be equal, and is used
by ==
.