software.amazon.awscdk.services.dynamodb

Class TableProps.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TableProps.Builder

Enclosing interface:

TableProps

@Stability(value=Experimental)
public static final class TableProps.Builder
extends Object

A builder for TableProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TableProps	build() Builds the configured instance.
TableProps.Builder	withBillingMode(BillingMode value) Sets the value of BillingMode
TableProps.Builder	withPartitionKey(Attribute value) Sets the value of PartitionKey
TableProps.Builder	withPointInTimeRecovery(Boolean value) Sets the value of PointInTimeRecovery
TableProps.Builder	withReadCapacity(Number value) Sets the value of ReadCapacity
TableProps.Builder	withServerSideEncryption(Boolean value) Sets the value of ServerSideEncryption
TableProps.Builder	withSortKey(Attribute value) Sets the value of SortKey
TableProps.Builder	withStream(StreamViewType value) Sets the value of Stream
TableProps.Builder	withTableName(String value) Sets the value of TableName
TableProps.Builder	withTimeToLiveAttribute(String value) Sets the value of TimeToLiveAttribute
TableProps.Builder	withWriteCapacity(Number value) Sets the value of WriteCapacity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withTableName

@Stability(value=Experimental)
public TableProps.Builder withTableName(@Nullable
                                                                       String value)

Sets the value of TableName

Parameters:

value - Enforces a particular physical table name.

Returns:

this

withPartitionKey

@Stability(value=Experimental)
public TableProps.Builder withPartitionKey(Attribute value)

Sets the value of PartitionKey

Parameters:

value - Partition key attribute definition.

Returns:

this

withBillingMode

@Stability(value=Experimental)
public TableProps.Builder withBillingMode(@Nullable
                                                                         BillingMode value)

Sets the value of BillingMode

Parameters:

value - Specify how you are charged for read and write throughput and how you manage capacity.

Returns:

this

withPointInTimeRecovery

@Stability(value=Experimental)
public TableProps.Builder withPointInTimeRecovery(@Nullable
                                                                                 Boolean value)

Sets the value of PointInTimeRecovery

Parameters:

value - Whether point-in-time recovery is enabled.

Returns:

this

withReadCapacity

@Stability(value=Experimental)
public TableProps.Builder withReadCapacity(@Nullable
                                                                          Number value)

Sets the value of ReadCapacity

Parameters:

value - The read capacity for the table.

Returns:

this

withServerSideEncryption

@Stability(value=Experimental)
public TableProps.Builder withServerSideEncryption(@Nullable
                                                                                  Boolean value)

Sets the value of ServerSideEncryption

Parameters:

value - Whether server-side encryption with an AWS managed customer master key is enabled.

Returns:

this

withSortKey

@Stability(value=Experimental)
public TableProps.Builder withSortKey(@Nullable
                                                                     Attribute value)

Sets the value of SortKey

Parameters:

value - Table sort key attribute definition.

Returns:

this

withStream

@Stability(value=Experimental)
public TableProps.Builder withStream(@Nullable
                                                                    StreamViewType value)

Sets the value of Stream

Parameters:

value - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Returns:

this

withTimeToLiveAttribute

@Stability(value=Experimental)
public TableProps.Builder withTimeToLiveAttribute(@Nullable
                                                                                 String value)

Sets the value of TimeToLiveAttribute

Parameters:

value - The name of TTL attribute.

Returns:

this

withWriteCapacity

@Stability(value=Experimental)
public TableProps.Builder withWriteCapacity(@Nullable
                                                                           Number value)

Sets the value of WriteCapacity

Parameters:

value - The write capacity for the table.

Returns:

this

build

@Stability(value=Experimental)
public TableProps build()

Builds the configured instance.

Returns:

a new instance of TableProps

Throws:

NullPointerException - if any required attribute was not provided