Struct aws_sdk_dynamodb::types::GlobalSecondaryIndexInfo

#[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>,
    pub on_demand_throughput: Option<OnDemandThroughput>,
}

Represents the properties of a global secondary index for the table when the backup was created.

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>

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.

on_demand_throughput: Option<OnDemandThroughput>

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Implementations

impl GlobalSecondaryIndexInfo

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

The name of the global secondary index.

pub fn key_schema(&self) -> &[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.

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 provisioned_throughput(&self) -> Option<&ProvisionedThroughput>

Represents the provisioned throughput settings for the specified global secondary index.

pub fn on_demand_throughput(&self) -> Option<&OnDemandThroughput>

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

impl GlobalSecondaryIndexInfo

pub fn builder() -> GlobalSecondaryIndexInfoBuilder

Creates a new builder-style object to manufacture GlobalSecondaryIndexInfo.

Trait Implementations

impl Clone for GlobalSecondaryIndexInfo

fn clone(&self) -> GlobalSecondaryIndexInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalSecondaryIndexInfo

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

Formats the value using the given formatter.

impl PartialEq for GlobalSecondaryIndexInfo

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