software.amazon.awssdk.services.dynamodb.model

Class UpdateTableRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest

software.amazon.awssdk.services.dynamodb.model.UpdateTableRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateTableRequest
extends DynamoDbRequest
implements ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

Represents the input of an UpdateTable operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateTableRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AttributeDefinition>	attributeDefinitions() An array of attributes that describe the key schema for the table and indexes.
BillingMode	billingMode() Controls how you are charged for read and write throughput and how you manage capacity.
String	billingModeAsString() Controls how you are charged for read and write throughput and how you manage capacity.
static UpdateTableRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<GlobalSecondaryIndexUpdate>	globalSecondaryIndexUpdates() An array of one or more global secondary indexes for the table.
int	hashCode()
ProvisionedThroughput	provisionedThroughput() The new provisioned throughput settings for the specified table or index.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateTableRequest.Builder>	serializableBuilderClass()
SSESpecification	sseSpecification() The new server-side encryption settings for the specified table.
StreamSpecification	streamSpecification() Represents the DynamoDB Streams configuration for the table.
String	tableName() The name of the table to be updated.
UpdateTableRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

attributeDefinitions

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

tableName

public String tableName()

The name of the table to be updated.

Returns:

The name of the table to be updated.

billingMode

public 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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

• PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

Returns:

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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

• PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

See Also:

BillingMode

billingModeAsString

public String billingModeAsString()

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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

• PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

Returns:

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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

• PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

See Also:

BillingMode

provisionedThroughput

public ProvisionedThroughput provisionedThroughput()

The new provisioned throughput settings for the specified table or index.

Returns:

The new provisioned throughput settings for the specified table or index.

globalSecondaryIndexUpdates

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

streamSpecification

public 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:

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.

sseSpecification

public SSESpecification sseSpecification()

The new server-side encryption settings for the specified table.

Returns:

The new server-side encryption settings for the specified table.

toBuilder

public UpdateTableRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static UpdateTableRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateTableRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo