software.amazon.awscdk.services.dynamodb

Class TableOptions.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TableOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TableOptions>

Enclosing interface:

TableOptions

@Stability(value=Stable)
public static final class TableOptions.Builder
extends Object
implements software.amazon.jsii.Builder<TableOptions>

A builder for TableOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TableOptions.Builder	billingMode(BillingMode billingMode) Sets the value of TableOptions.getBillingMode()
TableOptions	build() Builds the configured instance.
TableOptions.Builder	contributorInsightsEnabled(Boolean contributorInsightsEnabled) Sets the value of TableOptions.getContributorInsightsEnabled()
TableOptions.Builder	encryption(TableEncryption encryption) Sets the value of TableOptions.getEncryption()
TableOptions.Builder	encryptionKey(IKey encryptionKey) Sets the value of TableOptions.getEncryptionKey()
TableOptions.Builder	partitionKey(Attribute partitionKey) Sets the value of SchemaOptions.getPartitionKey()
TableOptions.Builder	pointInTimeRecovery(Boolean pointInTimeRecovery) Sets the value of TableOptions.getPointInTimeRecovery()
TableOptions.Builder	readCapacity(Number readCapacity) Sets the value of TableOptions.getReadCapacity()
TableOptions.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of TableOptions.getRemovalPolicy()
TableOptions.Builder	replicationRegions(List<String> replicationRegions) Sets the value of TableOptions.getReplicationRegions()
TableOptions.Builder	replicationTimeout(Duration replicationTimeout) Sets the value of TableOptions.getReplicationTimeout()
TableOptions.Builder	sortKey(Attribute sortKey) Sets the value of SchemaOptions.getSortKey()
TableOptions.Builder	stream(StreamViewType stream) Sets the value of TableOptions.getStream()
TableOptions.Builder	tableClass(TableClass tableClass) Sets the value of TableOptions.getTableClass()
TableOptions.Builder	timeToLiveAttribute(String timeToLiveAttribute) Sets the value of TableOptions.getTimeToLiveAttribute()
TableOptions.Builder	waitForReplicationToFinish(Boolean waitForReplicationToFinish) Sets the value of TableOptions.getWaitForReplicationToFinish()
TableOptions.Builder	writeCapacity(Number writeCapacity) Sets the value of TableOptions.getWriteCapacity()

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

billingMode

@Stability(value=Stable)
public TableOptions.Builder billingMode(BillingMode billingMode)

Sets the value of TableOptions.getBillingMode()

Parameters:

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

Returns:

this

contributorInsightsEnabled

@Stability(value=Stable)
public TableOptions.Builder contributorInsightsEnabled(Boolean contributorInsightsEnabled)

Sets the value of TableOptions.getContributorInsightsEnabled()

Parameters:

contributorInsightsEnabled - Whether CloudWatch contributor insights is enabled.

Returns:

this

encryption

@Stability(value=Stable)
public TableOptions.Builder encryption(TableEncryption encryption)

Sets the value of TableOptions.getEncryption()

Parameters:

encryption - Whether server-side encryption with an AWS managed customer master key is enabled. This property cannot be set if serverSideEncryption is set.

NOTE: if you set this to CUSTOMER_MANAGED and encryptionKey is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag @aws-cdk/aws-kms:defaultKeyPolicies is set to true in your cdk.json.

Returns:

this

encryptionKey

@Stability(value=Stable)
public TableOptions.Builder encryptionKey(IKey encryptionKey)

Sets the value of TableOptions.getEncryptionKey()

Parameters:

encryptionKey - External KMS key to use for table encryption. This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

Returns:

this

pointInTimeRecovery

@Stability(value=Stable)
public TableOptions.Builder pointInTimeRecovery(Boolean pointInTimeRecovery)

Sets the value of TableOptions.getPointInTimeRecovery()

Parameters:

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

Returns:

this

readCapacity

@Stability(value=Stable)
public TableOptions.Builder readCapacity(Number readCapacity)

Sets the value of TableOptions.getReadCapacity()

Parameters:

readCapacity - The read capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.

Returns:

this

removalPolicy

@Stability(value=Stable)
public TableOptions.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of TableOptions.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy to apply to the DynamoDB Table.

Returns:

this

replicationRegions

@Stability(value=Stable)
public TableOptions.Builder replicationRegions(List<String> replicationRegions)

Sets the value of TableOptions.getReplicationRegions()

Parameters:

replicationRegions - Regions where replica tables will be created.

Returns:

this

replicationTimeout

@Stability(value=Stable)
public TableOptions.Builder replicationTimeout(Duration replicationTimeout)

Sets the value of TableOptions.getReplicationTimeout()

Parameters:

replicationTimeout - The timeout for a table replication operation in a single region.

Returns:

this

stream

@Stability(value=Stable)
public TableOptions.Builder stream(StreamViewType stream)

Sets the value of TableOptions.getStream()

Parameters:

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

Returns:

this

tableClass

@Stability(value=Stable)
public TableOptions.Builder tableClass(TableClass tableClass)

Sets the value of TableOptions.getTableClass()

Parameters:

tableClass - Specify the table class.

Returns:

this

timeToLiveAttribute

@Stability(value=Stable)
public TableOptions.Builder timeToLiveAttribute(String timeToLiveAttribute)

Sets the value of TableOptions.getTimeToLiveAttribute()

Parameters:

timeToLiveAttribute - The name of TTL attribute.

Returns:

this

waitForReplicationToFinish

@Stability(value=Stable)
public TableOptions.Builder waitForReplicationToFinish(Boolean waitForReplicationToFinish)

Sets the value of TableOptions.getWaitForReplicationToFinish()

Parameters:

waitForReplicationToFinish - Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set.

DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion.

Returns:

this

writeCapacity

@Stability(value=Stable)
public TableOptions.Builder writeCapacity(Number writeCapacity)

Sets the value of TableOptions.getWriteCapacity()

Parameters:

writeCapacity - The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.

Returns:

this

partitionKey

@Stability(value=Stable)
public TableOptions.Builder partitionKey(Attribute partitionKey)

Sets the value of SchemaOptions.getPartitionKey()

Parameters:

partitionKey - Partition key attribute definition. This parameter is required.

Returns:

this

sortKey

@Stability(value=Stable)
public TableOptions.Builder sortKey(Attribute sortKey)

Sets the value of SchemaOptions.getSortKey()

Parameters:

sortKey - Sort key attribute definition.

Returns:

this

build

@Stability(value=Stable)
public TableOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<TableOptions>

Returns:

a new instance of TableOptions

Throws:

NullPointerException - if any required attribute was not provided