Struct aws_sdk_dynamodb::types::CreateGlobalSecondaryIndexAction

#[non_exhaustive]
pub struct CreateGlobalSecondaryIndexAction {
    pub index_name: String,
    pub key_schema: Vec<KeySchemaElement>,
    pub projection: Option<Projection>,
    pub provisioned_throughput: Option<ProvisionedThroughput>,
    pub on_demand_throughput: Option<OnDemandThroughput>,
    pub warm_throughput: Option<WarmThroughput>,
}

Represents a new global secondary index to be added to an existing table.

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: String

The name of the global secondary index to be created.

key_schema: Vec<KeySchemaElement>

The key schema for the global secondary index.

projection: Option<Projection>

Represents attributes that are copied (projected) from the table into an 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.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

on_demand_throughput: Option<OnDemandThroughput>

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

warm_throughput: Option<WarmThroughput>

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

Implementations

impl CreateGlobalSecondaryIndexAction

pub fn index_name(&self) -> &str

The name of the global secondary index to be created.

pub fn key_schema(&self) -> &[KeySchemaElement]

The key schema for the global secondary index.

pub fn projection(&self) -> Option<&Projection>

Represents attributes that are copied (projected) from the table into an 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.

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) -> Option<&OnDemandThroughput>

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

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

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

impl CreateGlobalSecondaryIndexAction

pub fn builder() -> CreateGlobalSecondaryIndexActionBuilder

Creates a new builder-style object to manufacture CreateGlobalSecondaryIndexAction.

Trait Implementations

impl Clone for CreateGlobalSecondaryIndexAction

fn clone(&self) -> CreateGlobalSecondaryIndexAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateGlobalSecondaryIndexAction

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

Formats the value using the given formatter.

impl PartialEq for CreateGlobalSecondaryIndexAction

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