public class UpdateTableRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Enable or disable Streams on the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. Once 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.
Constructor and Description |
---|
UpdateTableRequest()
Default constructor for UpdateTableRequest object.
|
UpdateTableRequest(java.lang.String tableName,
ProvisionedThroughput provisionedThroughput)
Constructs a new UpdateTableRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<AttributeDefinition> |
getAttributeDefinitions()
An array of attributes that describe the key schema for the table and
indexes.
|
java.util.List<GlobalSecondaryIndexUpdate> |
getGlobalSecondaryIndexUpdates()
An array of one or more global secondary indexes for the table.
|
ProvisionedThroughput |
getProvisionedThroughput()
Represents the provisioned throughput settings for a specified table or
index.
|
StreamSpecification |
getStreamSpecification()
Represents the DynamoDB Streams configuration for the table.
|
java.lang.String |
getTableName()
The name of the table to be updated.
|
int |
hashCode() |
void |
setAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and
indexes.
|
void |
setGlobalSecondaryIndexUpdates(java.util.Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)
An array of one or more global secondary indexes for the table.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or
index.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
|
void |
setTableName(java.lang.String tableName)
The name of the table to be updated.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateTableRequest |
withAttributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of attributes that describe the key schema for the table and
indexes.
|
UpdateTableRequest |
withAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and
indexes.
|
UpdateTableRequest |
withGlobalSecondaryIndexUpdates(java.util.Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)
An array of one or more global secondary indexes for the table.
|
UpdateTableRequest |
withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates)
An array of one or more global secondary indexes for the table.
|
UpdateTableRequest |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or
index.
|
UpdateTableRequest |
withStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
|
UpdateTableRequest |
withTableName(java.lang.String tableName)
The name of the table to be updated.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public UpdateTableRequest()
public UpdateTableRequest(java.lang.String tableName, ProvisionedThroughput provisionedThroughput)
tableName
- The name of the table to be updated.
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.
public java.util.List<AttributeDefinition> getAttributeDefinitions()
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.
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 void setAttributeDefinitions(java.util.Collection<AttributeDefinition> 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.
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 UpdateTableRequest withAttributeDefinitions(AttributeDefinition... 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.
Returns a reference to this object so that method calls can be chained together.
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 UpdateTableRequest withAttributeDefinitions(java.util.Collection<AttributeDefinition> 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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getTableName()
The name of the table to be updated.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table to be updated.
public void setTableName(java.lang.String tableName)
The name of the table to be updated.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table to be updated.
public UpdateTableRequest withTableName(java.lang.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_.-]+
tableName
- The name of the table to be updated.
public ProvisionedThroughput getProvisionedThroughput()
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.
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.
public void setProvisionedThroughput(ProvisionedThroughput 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.
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.
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput 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.
Returns a reference to this object so that method calls can be chained together.
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.
public java.util.List<GlobalSecondaryIndexUpdate> getGlobalSecondaryIndexUpdates()
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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
public void setGlobalSecondaryIndexUpdates(java.util.Collection<GlobalSecondaryIndexUpdate> 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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
public UpdateTableRequest withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... 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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
public UpdateTableRequest withGlobalSecondaryIndexUpdates(java.util.Collection<GlobalSecondaryIndexUpdate> 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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
public StreamSpecification getStreamSpecification()
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
public void setStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
streamSpecification
- Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
public UpdateTableRequest withStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
Returns a reference to this object so that method calls can be chained together.
streamSpecification
- Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.