Struct aws_sdk_dynamodb::types::builders::GlobalSecondaryIndexBuilder

#[non_exhaustive]
pub struct GlobalSecondaryIndexBuilder { /* private fields */ }

A builder for GlobalSecondaryIndex.

Implementations

impl GlobalSecondaryIndexBuilder

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.

This field is required.

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 get_index_name(&self) -> &Option<String>

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 get_key_schema(&self) -> &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.

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.

This field is required.

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 get_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, 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 get_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.

pub fn on_demand_throughput(self, input: OnDemandThroughput) -> Self

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

pub fn set_on_demand_throughput(self, input: Option<OnDemandThroughput>) -> Self

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

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

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

pub fn warm_throughput(self, input: WarmThroughput) -> Self

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

pub fn set_warm_throughput(self, input: Option<WarmThroughput>) -> Self

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

pub fn get_warm_throughput(&self) -> &Option<WarmThroughput>

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

pub fn build(self) -> Result<GlobalSecondaryIndex, BuildError>

Consumes the builder and constructs a GlobalSecondaryIndex. This method will fail if any of the following fields are not set:

• index_name
• key_schema

Trait Implementations

impl Clone for GlobalSecondaryIndexBuilder

fn clone(&self) -> GlobalSecondaryIndexBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalSecondaryIndexBuilder

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

Formats the value using the given formatter.

impl Default for GlobalSecondaryIndexBuilder

fn default() -> GlobalSecondaryIndexBuilder

Returns the “default value” for a type.

impl PartialEq for GlobalSecondaryIndexBuilder

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