@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateTableRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of an UpdateTable
operation.
NOOP
Constructor and Description |
---|
UpdateTableRequest()
Default constructor for UpdateTableRequest object.
|
UpdateTableRequest(String tableName,
ProvisionedThroughput provisionedThroughput)
Constructs a new UpdateTableRequest object.
|
Modifier and Type | Method and Description |
---|---|
UpdateTableRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<AttributeDefinition> |
getAttributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
|
String |
getBillingMode()
Controls how you are charged for read and write throughput and how you manage capacity.
|
Boolean |
getDeletionProtectionEnabled()
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
|
List<GlobalSecondaryIndexUpdate> |
getGlobalSecondaryIndexUpdates()
An array of one or more global secondary indexes for the table.
|
OnDemandThroughput |
getOnDemandThroughput()
Updates the maximum number of read and write units for the specified table in on-demand capacity mode.
|
ProvisionedThroughput |
getProvisionedThroughput()
The new provisioned throughput settings for the specified table or index.
|
List<ReplicationGroupUpdate> |
getReplicaUpdates()
A list of replica update actions (create, delete, or update) for the table.
|
SSESpecification |
getSSESpecification()
The new server-side encryption settings for the specified table.
|
StreamSpecification |
getStreamSpecification()
Represents the DynamoDB Streams configuration for the table.
|
String |
getTableClass()
The table class of the table to be updated.
|
String |
getTableName()
The name of the table to be updated.
|
int |
hashCode() |
Boolean |
isDeletionProtectionEnabled()
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
|
void |
setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
|
void |
setBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
void |
setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
|
void |
setGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)
An array of one or more global secondary indexes for the table.
|
void |
setOnDemandThroughput(OnDemandThroughput onDemandThroughput)
Updates the maximum number of read and write units for the specified table in on-demand capacity mode.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The new provisioned throughput settings for the specified table or index.
|
void |
setReplicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
|
void |
setSSESpecification(SSESpecification sSESpecification)
The new server-side encryption settings for the specified table.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
|
void |
setTableClass(String tableClass)
The table class of the table to be updated.
|
void |
setTableName(String tableName)
The name of the table to be updated.
|
String |
toString()
Returns a string representation of this object.
|
UpdateTableRequest |
withAttributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
|
UpdateTableRequest |
withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
|
UpdateTableRequest |
withBillingMode(BillingMode billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
UpdateTableRequest |
withBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
UpdateTableRequest |
withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
|
UpdateTableRequest |
withGlobalSecondaryIndexUpdates(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 |
withOnDemandThroughput(OnDemandThroughput onDemandThroughput)
Updates the maximum number of read and write units for the specified table in on-demand capacity mode.
|
UpdateTableRequest |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The new provisioned throughput settings for the specified table or index.
|
UpdateTableRequest |
withReplicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
|
UpdateTableRequest |
withReplicaUpdates(ReplicationGroupUpdate... replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
|
UpdateTableRequest |
withSSESpecification(SSESpecification sSESpecification)
The new server-side encryption settings for the specified table.
|
UpdateTableRequest |
withStreamSpecification(StreamSpecification streamSpecification)
Represents the DynamoDB Streams configuration for the table.
|
UpdateTableRequest |
withTableClass(String tableClass)
The table class of the table to be updated.
|
UpdateTableRequest |
withTableClass(TableClass tableClass)
The table class of the table to be updated.
|
UpdateTableRequest |
withTableName(String tableName)
The name of the table to be updated.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public UpdateTableRequest()
public UpdateTableRequest(String tableName, ProvisionedThroughput provisionedThroughput)
tableName
- The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in
this parameter.provisionedThroughput
- The new provisioned throughput settings for the specified table or index.public 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.
AttributeDefinitions
must include the key element(s) of
the new index.public void setAttributeDefinitions(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.
NOTE: This method appends the values to the existing list (if any). Use
setAttributeDefinitions(java.util.Collection)
or withAttributeDefinitions(java.util.Collection)
if you want to override the existing values.
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(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 void setTableName(String tableName)
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName
- The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in
this parameter.public String getTableName()
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
public UpdateTableRequest withTableName(String tableName)
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName
- The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in
this parameter.public void setBillingMode(String 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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-demand
capacity mode.
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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
BillingMode
public String getBillingMode()
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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-demand
capacity mode.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
BillingMode
public UpdateTableRequest withBillingMode(String 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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-demand
capacity mode.
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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
BillingMode
public UpdateTableRequest withBillingMode(BillingMode 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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-demand
capacity mode.
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 capacity mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
BillingMode
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The new provisioned throughput settings for the specified table or index.
provisionedThroughput
- The new provisioned throughput settings for the specified table or index.public ProvisionedThroughput getProvisionedThroughput()
The new provisioned throughput settings for the specified table or index.
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
The new provisioned throughput settings for the specified table or index.
provisionedThroughput
- The new provisioned throughput settings for the specified table or index.public 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.
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.
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 void setGlobalSecondaryIndexUpdates(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.
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.
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 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.
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.
NOTE: This method appends the values to the existing list (if any). Use
setGlobalSecondaryIndexUpdates(java.util.Collection)
or
withGlobalSecondaryIndexUpdates(java.util.Collection)
if you want to override the existing values.
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 UpdateTableRequest withGlobalSecondaryIndexUpdates(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.
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.
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 void setStreamSpecification(StreamSpecification 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.
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.
public StreamSpecification getStreamSpecification()
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.
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.
public UpdateTableRequest withStreamSpecification(StreamSpecification 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.
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.
public void setSSESpecification(SSESpecification sSESpecification)
The new server-side encryption settings for the specified table.
sSESpecification
- The new server-side encryption settings for the specified table.public SSESpecification getSSESpecification()
The new server-side encryption settings for the specified table.
public UpdateTableRequest withSSESpecification(SSESpecification sSESpecification)
The new server-side encryption settings for the specified table.
sSESpecification
- The new server-side encryption settings for the specified table.public List<ReplicationGroupUpdate> getReplicaUpdates()
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
public void setReplicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
replicaUpdates
- A list of replica update actions (create, delete, or update) for the table. For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
public UpdateTableRequest withReplicaUpdates(ReplicationGroupUpdate... replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
NOTE: This method appends the values to the existing list (if any). Use
setReplicaUpdates(java.util.Collection)
or withReplicaUpdates(java.util.Collection)
if you want
to override the existing values.
replicaUpdates
- A list of replica update actions (create, delete, or update) for the table. For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
public UpdateTableRequest withReplicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
replicaUpdates
- A list of replica update actions (create, delete, or update) for the table. For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
public void setTableClass(String tableClass)
The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
tableClass
- The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.TableClass
public String getTableClass()
The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
STANDARD
and
STANDARD_INFREQUENT_ACCESS
.TableClass
public UpdateTableRequest withTableClass(String tableClass)
The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
tableClass
- The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.TableClass
public UpdateTableRequest withTableClass(TableClass tableClass)
The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
tableClass
- The table class of the table to be updated. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.TableClass
public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
deletionProtectionEnabled
- Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.public Boolean getDeletionProtectionEnabled()
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
public UpdateTableRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
deletionProtectionEnabled
- Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.public Boolean isDeletionProtectionEnabled()
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
public void setOnDemandThroughput(OnDemandThroughput 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.
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.public OnDemandThroughput getOnDemandThroughput()
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.
MaxReadRequestUnits
,
MaxWriteRequestUnits
, or both.public UpdateTableRequest withOnDemandThroughput(OnDemandThroughput 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.
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.public String toString()
toString
in class Object
Object.toString()
public UpdateTableRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()