Struct aws_sdk_dynamodb::model::global_secondary_index::Builder

pub struct Builder { /* private fields */ }

A builder for GlobalSecondaryIndex.

Implementations

impl Builder

pub fn index_name(self, input: impl Into<String>) -> Self

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

pub fn set_index_name(self, input: Option<String>) -> Self

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

pub fn key_schema(self, input: KeySchemaElement) -> Self

Appends an item to key_schema.

To override the contents of this collection use set_key_schema.

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.

pub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self

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.

pub fn projection(self, input: Projection) -> Self

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 set_projection(self, input: Option<Projection>) -> Self

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, input: ProvisionedThroughput) -> Self

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.

pub fn set_provisioned_throughput(
    self,
    input: Option<ProvisionedThroughput>
) -> Self

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.

pub fn build(self) -> GlobalSecondaryIndex

Consumes the builder and constructs a GlobalSecondaryIndex.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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