Struct aws_sdk_dynamodb::operation::update_table::UpdateTableInput

#[non_exhaustive]
pub struct UpdateTableInput {
    pub attribute_definitions: Option<Vec<AttributeDefinition>>,
    pub table_name: Option<String>,
    pub billing_mode: Option<BillingMode>,
    pub provisioned_throughput: Option<ProvisionedThroughput>,
    pub global_secondary_index_updates: Option<Vec<GlobalSecondaryIndexUpdate>>,
    pub stream_specification: Option<StreamSpecification>,
    pub sse_specification: Option<SseSpecification>,
    pub replica_updates: Option<Vec<ReplicationGroupUpdate>>,
    pub table_class: Option<TableClass>,
    pub deletion_protection_enabled: Option<bool>,
    pub on_demand_throughput: Option<OnDemandThroughput>,
}

Represents the input of an UpdateTable operation.

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.

attribute_definitions: Option<Vec<AttributeDefinition>>

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

table_name: Option<String>

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

billing_mode: Option<BillingMode>

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

provisioned_throughput: Option<ProvisionedThroughput>

The new provisioned throughput settings for the specified table or index.

global_secondary_index_updates: Option<Vec<GlobalSecondaryIndexUpdate>>

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

• Create - add a new global secondary index to the table.

• Update - modify the provisioned throughput settings of an existing global secondary index.

• Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

stream_specification: Option<StreamSpecification>

Represents the DynamoDB Streams configuration for the table.

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

sse_specification: Option<SseSpecification>

The new server-side encryption settings for the specified table.

replica_updates: Option<Vec<ReplicationGroupUpdate>>

A list of replica update actions (create, delete, or update) for the table.

For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

table_class: Option<TableClass>

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

deletion_protection_enabled: Option<bool>

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

on_demand_throughput: Option<OnDemandThroughput>

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

Implementations

impl UpdateTableInput

pub fn attribute_definitions(&self) -> &[AttributeDefinition]

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attribute_definitions.is_none().

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

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

pub fn billing_mode(&self) -> Option<&BillingMode>

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

pub fn provisioned_throughput(&self) -> Option<&ProvisionedThroughput>

The new provisioned throughput settings for the specified table or index.

pub fn global_secondary_index_updates(&self) -> &[GlobalSecondaryIndexUpdate]

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

• Create - add a new global secondary index to the table.

• Update - modify the provisioned throughput settings of an existing global secondary index.

• Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .global_secondary_index_updates.is_none().

pub fn stream_specification(&self) -> Option<&StreamSpecification>

Represents the DynamoDB Streams configuration for the table.

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

pub fn sse_specification(&self) -> Option<&SseSpecification>

The new server-side encryption settings for the specified table.

pub fn replica_updates(&self) -> &[ReplicationGroupUpdate]

A list of replica update actions (create, delete, or update) for the table.

For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .replica_updates.is_none().

pub fn table_class(&self) -> Option<&TableClass>

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

pub fn deletion_protection_enabled(&self) -> Option<bool>

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

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

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

impl UpdateTableInput

pub fn builder() -> UpdateTableInputBuilder

Creates a new builder-style object to manufacture UpdateTableInput.

Trait Implementations

impl Clone for UpdateTableInput

fn clone(&self) -> UpdateTableInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateTableInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateTableInput

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