UpdateTableRequest Class

Container for the parameters to the UpdateTable operation.

Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.

The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.

The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous operation; while executing the operation, the table is in the UPDATING state. While the table is in the UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable operation.

You cannot add, modify or delete indexes using UpdateTable . Indexes can only be defined at table creation time.

Declaration Syntax

public class UpdateTableRequest : AmazonWebServiceRequest

Members

Icon	Member	Description
	UpdateTableRequest()()()()	Initializes a new instance of the UpdateTableRequest class
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode()()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()()	Gets the type of the current instance. (Inherited from Object.)
	GlobalSecondaryIndexUpdates	An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
	ProvisionedThroughput	Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
	TableName	The name of the table to be updated. Constraints: Length 3 - 255 Pattern [a-zA-Z0-9_.-]+
	ToString()()()()	Returns a string that represents the current object. (Inherited from Object.)
	WithGlobalSecondaryIndexUpdates(array<GlobalSecondaryIndexUpdate>[]()[][])	Obsolete. Adds elements to the GlobalSecondaryIndexUpdates collection
	WithGlobalSecondaryIndexUpdates(IEnumerable<(Of <<'(GlobalSecondaryIndexUpdate>)>>))	Obsolete. Adds elements to the GlobalSecondaryIndexUpdates collection
	WithProvisionedThroughput(ProvisionedThroughput)	Obsolete. Sets the ProvisionedThroughput property
	WithTableName(String)	Obsolete. Sets the TableName property

Examples

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

CopyUpdateTable 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 = client.UpdateTable(request).UpdateTableResult.TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

Inheritance Hierarchy

Object
	AmazonWebServiceRequest
		UpdateTableRequest

All Members	Constructors	Methods	Properties
Public Protected		Instance Static		Declared Inherited