UpdateTableRequest Class | AWS SDK for .NET Version 4

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's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.UpdateTableRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public class UpdateTableRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The UpdateTableRequest type exposes the following members

Constructors

	Name	Description
	UpdateTableRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	UpdateTableRequest(string, ProvisionedThroughput)	Instantiates UpdateTableRequest with the parameterized properties

Properties

Name	Type	Description
AttributeDefinitions	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.AttributeDefinition>	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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
BillingMode	Amazon.DynamoDBv2.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. `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for most DynamoDB workloads. `PAY_PER_REQUEST` sets the billing mode to On-demand capacity mode. `PROVISIONED` - We recommend using `PROVISIONED` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. `PROVISIONED` sets the billing mode to Provisioned capacity mode.
DeletionProtectionEnabled	System.Nullable<System.Boolean>	Gets and sets the property DeletionProtectionEnabled. Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
GlobalSecondaryIndexUpdates	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate>	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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
GlobalTableWitnessUpdates	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.GlobalTableWitnessGroupUpdate>	Gets and sets the property GlobalTableWitnessUpdates. A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action: `Create` - add a new witness to the global table. `Delete` - remove a witness from the global table. You can create or delete only one witness per `UpdateTable` operation. For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
MultiRegionConsistency	Amazon.DynamoDBv2.MultiRegionConsistency	Gets and sets the property MultiRegionConsistency. Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list. You can specify one of the following consistency modes: `EVENTUAL`: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables. `STRONG`: Configures a new global table for multi-Region strong consistency (MRSC). If you don't specify this field, the global table consistency mode defaults to `EVENTUAL`. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
OnDemandThroughput	Amazon.DynamoDBv2.Model.OnDemandThroughput	Gets and sets the property 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.
ProvisionedThroughput	Amazon.DynamoDBv2.Model.ProvisionedThroughput	Gets and sets the property ProvisionedThroughput. The new provisioned throughput settings for the specified table or index.
ReplicaUpdates	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.ReplicationGroupUpdate>	Gets and sets the property ReplicaUpdates. A list of replica update actions (create, delete, or update) for the table. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
SSESpecification	Amazon.DynamoDBv2.Model.SSESpecification	Gets and sets the property SSESpecification. The new server-side encryption settings for the specified table.
StreamSpecification	Amazon.DynamoDBv2.Model.StreamSpecification	Gets and sets the property 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.
TableClass	Amazon.DynamoDBv2.TableClass	Gets and sets the property TableClass. The table class of the table to be updated. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.
TableName	System.String	Gets and sets the property TableName. The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
WarmThroughput	Amazon.DynamoDBv2.Model.WarmThroughput	Gets and sets the property WarmThroughput. Represents the warm throughput (in read units per second and write units per second) for updating a table.

Examples

This example shows how to update the throughput settings of a table. New throughput will be 40 ReadCapacityUnits and 50 WriteCapacityUnits.

UpdateTable sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define new table throughput:
//  Table will now have capacity of 40 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 40,
    WriteCapacityUnits = 50
};

// Compose the UpdateTable request
UpdateTableRequest request = new UpdateTableRequest
{
    TableName = "SampleTable",
    ProvisionedThroughput = throughput
};

// View new table properties
TableDescription tableDescription = (await client.UpdateTableAsync(request)).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer