Table of Contents

Class UpdateTableRequest

Namespace
Amazon.DynamoDBv2.Model
Assembly
AWSSDK.DynamoDBv2.dll

Container for the parameters to the UpdateTable operation. Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use 

    UpdateTable
    to perform other operations. 

UpdateTable
is an asynchronous operation; while it is executing, the table status changes from 
ACTIVE
to 
UPDATING
. While it is 
UPDATING
, you cannot issue another 
UpdateTable
request. When the table returns to the 
ACTIVE
state, the 
UpdateTable
operation is complete. 
public class UpdateTableRequest : AmazonDynamoDBRequest
Inheritance
UpdateTableRequest

Constructors

UpdateTableRequest()

Empty constructor used to set properties independently even when a simple constructor is available

public UpdateTableRequest()

UpdateTableRequest(string, ProvisionedThroughput)

Instantiates UpdateTableRequest with the parameterized properties

public UpdateTableRequest(string tableName, ProvisionedThroughput provisionedThroughput)

Parameters

tableName string

The name of the table to be updated.

provisionedThroughput ProvisionedThroughput

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

Properties

AttributeDefinitions

Gets and sets the property AttributeDefinitions.

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. 
public List<AttributeDefinition> AttributeDefinitions { get; set; }

Property Value

List<AttributeDefinition>

BillingMode

Gets and sets the property 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 Mode. 

  • PAY_PER_REQUEST
    - We recommend using 
    PAY_PER_REQUEST
    for unpredictable workloads. 
    PAY_PER_REQUEST
    sets the billing mode to On-Demand Mode. 
public BillingMode BillingMode { get; set; }

Property Value

BillingMode

GlobalSecondaryIndexUpdates

Gets and sets the property GlobalSecondaryIndexUpdates.

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. 

public List<GlobalSecondaryIndexUpdate> GlobalSecondaryIndexUpdates { get; set; }

Property Value

List<GlobalSecondaryIndexUpdate>

ProvisionedThroughput

Gets and sets the property ProvisionedThroughput.

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

public ProvisionedThroughput ProvisionedThroughput { get; set; }

Property Value

ProvisionedThroughput

ReplicaUpdates

Gets and sets the property ReplicaUpdates.

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

note

This property only applies to Version 2019.11.21 of global tables. 

public List<ReplicationGroupUpdate> ReplicaUpdates { get; set; }

Property Value

List<ReplicationGroupUpdate>

SSESpecification

Gets and sets the property SSESpecification.

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

public SSESpecification SSESpecification { get; set; }

Property Value

SSESpecification

StreamSpecification

Gets and sets the property StreamSpecification.

Represents the DynamoDB Streams configuration for the table.

note

You receive a 

ResourceInUseException
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. 
public StreamSpecification StreamSpecification { get; set; }

Property Value

StreamSpecification

TableClass

Gets and sets the property TableClass.

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

STANDARD
and 
STANDARD_INFREQUENT_ACCESS
. 
public TableClass TableClass { get; set; }

Property Value

TableClass

TableName

Gets and sets the property TableName.

The name of the table to be updated. 

public string TableName { get; set; }

Property Value

string