Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.dynamodbv2.model
Class UpdateTableRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.dynamodbv2.model.UpdateTableRequest
All Implemented Interfaces:
Serializable

public class UpdateTableRequest
extends AmazonWebServiceRequest
implements Serializable

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 Amazon 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 local secondary indexes using UpdateTable . Local secondary indexes can only be defined at table creation time.

See Also:
AmazonDynamoDB.updateTable(UpdateTableRequest), Serialized Form

Constructor Summary
UpdateTableRequest()
           
 
Method Summary
 boolean equals(Object obj)
           
 ProvisionedThroughput getProvisionedThroughput()
          The provisioned throughput settings for the specified table.
 String getTableName()
          The name of the table to be updated.
 int hashCode()
           
 void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
          The provisioned throughput settings for the specified table.
 void setTableName(String tableName)
          The name of the table to be updated.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
          The provisioned throughput settings for the specified table.
 UpdateTableRequest withTableName(String tableName)
          The name of the table to be updated.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateTableRequest

public UpdateTableRequest()
Method Detail

getTableName

public String getTableName()
The name of the table to be updated.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:
The name of the table to be updated.

setTableName

public void setTableName(String tableName)
The name of the table to be updated.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:
tableName - The name of the table to be updated.

withTableName

public UpdateTableRequest withTableName(String tableName)
The name of the table to be updated.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:
tableName - The name of the table to be updated.
Returns:
A reference to this updated object so that method calls can be chained together.

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()
The provisioned throughput settings for the specified table. 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.

Returns:
The provisioned throughput settings for the specified table. 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.


setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The provisioned throughput settings for the specified table. 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.

Parameters:
provisionedThroughput - The provisioned throughput settings for the specified table. 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.


withProvisionedThroughput

public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The provisioned throughput settings for the specified table. 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
provisionedThroughput - The provisioned throughput settings for the specified table. 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.

Returns:
A reference to this updated object so that method calls can be chained together.

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.