Package software.amazon.awscdk.services.dynamodb

Class TablePropsV2.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TablePropsV2.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TablePropsV2>

Enclosing interface:

TablePropsV2

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

A builder for TablePropsV2

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TablePropsV2.Builder	billing(Billing billing)	Sets the value of TablePropsV2.getBilling()
TablePropsV2	build()	Builds the configured instance.
TablePropsV2.Builder	contributorInsights(Boolean contributorInsights)	Deprecated. use `contributorInsightsSpecification` instead
TablePropsV2.Builder	contributorInsightsSpecification(ContributorInsightsSpecification contributorInsightsSpecification)	Sets the value of TableOptionsV2.getContributorInsightsSpecification()
TablePropsV2.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of TableOptionsV2.getDeletionProtection()
TablePropsV2.Builder	dynamoStream(StreamViewType dynamoStream)	Sets the value of TablePropsV2.getDynamoStream()
TablePropsV2.Builder	encryption(TableEncryptionV2 encryption)	Sets the value of TablePropsV2.getEncryption()
TablePropsV2.Builder	globalSecondaryIndexes(List<? extends GlobalSecondaryIndexPropsV2> globalSecondaryIndexes)	Sets the value of TablePropsV2.getGlobalSecondaryIndexes()
TablePropsV2.Builder	kinesisStream(IStream kinesisStream)	Sets the value of TableOptionsV2.getKinesisStream()
TablePropsV2.Builder	localSecondaryIndexes(List<? extends LocalSecondaryIndexProps> localSecondaryIndexes)	Sets the value of TablePropsV2.getLocalSecondaryIndexes()
TablePropsV2.Builder	multiRegionConsistency(MultiRegionConsistency multiRegionConsistency)	Sets the value of TablePropsV2.getMultiRegionConsistency()
TablePropsV2.Builder	partitionKey(Attribute partitionKey)	Sets the value of TablePropsV2.getPartitionKey()
TablePropsV2.Builder	pointInTimeRecovery(Boolean pointInTimeRecovery)	Deprecated. use `pointInTimeRecoverySpecification` instead
TablePropsV2.Builder	pointInTimeRecoverySpecification(PointInTimeRecoverySpecification pointInTimeRecoverySpecification)	Sets the value of TableOptionsV2.getPointInTimeRecoverySpecification()
TablePropsV2.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of TablePropsV2.getRemovalPolicy()
TablePropsV2.Builder	replicas(List<? extends ReplicaTableProps> replicas)	Sets the value of TablePropsV2.getReplicas()
TablePropsV2.Builder	resourcePolicy(PolicyDocument resourcePolicy)	Sets the value of TableOptionsV2.getResourcePolicy()
TablePropsV2.Builder	sortKey(Attribute sortKey)	Sets the value of TablePropsV2.getSortKey()
TablePropsV2.Builder	tableClass(TableClass tableClass)	Sets the value of TableOptionsV2.getTableClass()
TablePropsV2.Builder	tableName(String tableName)	Sets the value of TablePropsV2.getTableName()
TablePropsV2.Builder	tags(List<? extends CfnTag> tags)	Sets the value of TableOptionsV2.getTags()
TablePropsV2.Builder	timeToLiveAttribute(String timeToLiveAttribute)	Sets the value of TablePropsV2.getTimeToLiveAttribute()
TablePropsV2.Builder	warmThroughput(WarmThroughput warmThroughput)	Sets the value of TablePropsV2.getWarmThroughput()
TablePropsV2.Builder	witnessRegion(String witnessRegion)	Sets the value of TablePropsV2.getWitnessRegion()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

partitionKey

@Stability(Stable)
public TablePropsV2.Builder partitionKey(Attribute partitionKey)

Sets the value of TablePropsV2.getPartitionKey()

Parameters:

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

Returns:

this

billing

@Stability(Stable)
public TablePropsV2.Builder billing(Billing billing)

Sets the value of TablePropsV2.getBilling()

Parameters:

billing - The billing mode and capacity settings to apply to the table.

Returns:

this

dynamoStream

@Stability(Stable)
public TablePropsV2.Builder dynamoStream(StreamViewType dynamoStream)

Sets the value of TablePropsV2.getDynamoStream()

Parameters:

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

Returns:

this

encryption

@Stability(Stable)
public TablePropsV2.Builder encryption(TableEncryptionV2 encryption)

Sets the value of TablePropsV2.getEncryption()

Parameters:

encryption - The server-side encryption.

Returns:

this

globalSecondaryIndexes

@Stability(Stable)
public TablePropsV2.Builder globalSecondaryIndexes(List<? extends GlobalSecondaryIndexPropsV2> globalSecondaryIndexes)

Sets the value of TablePropsV2.getGlobalSecondaryIndexes()

Parameters:

globalSecondaryIndexes - Global secondary indexes. Note: You can provide a maximum of 20 global secondary indexes.

Returns:

this

localSecondaryIndexes

@Stability(Stable)
public TablePropsV2.Builder localSecondaryIndexes(List<? extends LocalSecondaryIndexProps> localSecondaryIndexes)

Sets the value of TablePropsV2.getLocalSecondaryIndexes()

Parameters:

localSecondaryIndexes - Local secondary indexes. Note: You can only provide a maximum of 5 local secondary indexes.

Returns:

this

multiRegionConsistency

@Stability(Stable)
public TablePropsV2.Builder multiRegionConsistency(MultiRegionConsistency multiRegionConsistency)

Sets the value of TablePropsV2.getMultiRegionConsistency()

Parameters:

multiRegionConsistency - Specifies the consistency mode for a new global table.

Returns:

this

removalPolicy

@Stability(Stable)
public TablePropsV2.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of TablePropsV2.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy applied to the table.

Returns:

this

replicas

@Stability(Stable)
public TablePropsV2.Builder replicas(List<? extends ReplicaTableProps> replicas)

Sets the value of TablePropsV2.getReplicas()

Parameters:

replicas - Replica tables to deploy with the primary table. Note: Adding replica tables allows you to use your table as a global table. You cannot specify a replica table in the region that the primary table will be deployed to. Replica tables will only be supported if the stack deployment region is defined.

Returns:

this

sortKey

@Stability(Stable)
public TablePropsV2.Builder sortKey(Attribute sortKey)

Sets the value of TablePropsV2.getSortKey()

Parameters:

sortKey - Sort key attribute definition.

Returns:

this

tableName

@Stability(Stable)
public TablePropsV2.Builder tableName(String tableName)

Sets the value of TablePropsV2.getTableName()

Parameters:

tableName - The name of the table.

Returns:

this

timeToLiveAttribute

@Stability(Stable)
public TablePropsV2.Builder timeToLiveAttribute(String timeToLiveAttribute)

Sets the value of TablePropsV2.getTimeToLiveAttribute()

Parameters:

timeToLiveAttribute - The name of the TTL attribute.

Returns:

this

warmThroughput

@Stability(Stable)
public TablePropsV2.Builder warmThroughput(WarmThroughput warmThroughput)

Sets the value of TablePropsV2.getWarmThroughput()

Parameters:

warmThroughput - The warm throughput configuration for the table.

Returns:

this

witnessRegion

@Stability(Stable)
public TablePropsV2.Builder witnessRegion(String witnessRegion)

Sets the value of TablePropsV2.getWitnessRegion()

Parameters:

witnessRegion - The witness Region for the MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

Note: Witness region cannot be specified for a Multi-Region Eventual Consistency (MREC) Global Table. Witness regions are only supported for Multi-Region Strong Consistency (MRSC) Global Tables.

Returns:

this

contributorInsights

@Stability(Deprecated)
@Deprecated
public TablePropsV2.Builder contributorInsights(Boolean contributorInsights)

Deprecated.

use `contributorInsightsSpecification` instead

Sets the value of TableOptionsV2.getContributorInsights()

Parameters:

contributorInsights - Whether CloudWatch contributor insights is enabled.

Returns:

this

contributorInsightsSpecification

@Stability(Stable)
public TablePropsV2.Builder contributorInsightsSpecification(ContributorInsightsSpecification contributorInsightsSpecification)

Sets the value of TableOptionsV2.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - Whether CloudWatch contributor insights is enabled and what mode is selected.

Returns:

this

deletionProtection

@Stability(Stable)
public TablePropsV2.Builder deletionProtection(Boolean deletionProtection)

Sets the value of TableOptionsV2.getDeletionProtection()

Parameters:

deletionProtection - Whether deletion protection is enabled.

Returns:

this

kinesisStream

@Stability(Stable)
public TablePropsV2.Builder kinesisStream(IStream kinesisStream)

Sets the value of TableOptionsV2.getKinesisStream()

Parameters:

kinesisStream - Kinesis Data Stream to capture item level changes.

Returns:

this

pointInTimeRecovery

@Stability(Deprecated)
@Deprecated
public TablePropsV2.Builder pointInTimeRecovery(Boolean pointInTimeRecovery)

Deprecated.

use `pointInTimeRecoverySpecification` instead

Sets the value of TableOptionsV2.getPointInTimeRecovery()

Parameters:

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

Returns:

this

pointInTimeRecoverySpecification

@Stability(Stable)
public TablePropsV2.Builder pointInTimeRecoverySpecification(PointInTimeRecoverySpecification pointInTimeRecoverySpecification)

Sets the value of TableOptionsV2.getPointInTimeRecoverySpecification()

Parameters:

pointInTimeRecoverySpecification - Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

Returns:

this

resourcePolicy

@Stability(Stable)
public TablePropsV2.Builder resourcePolicy(PolicyDocument resourcePolicy)

Sets the value of TableOptionsV2.getResourcePolicy()

Parameters:

resourcePolicy - Resource policy to assign to DynamoDB Table.

Returns:

this

tableClass

@Stability(Stable)
public TablePropsV2.Builder tableClass(TableClass tableClass)

Sets the value of TableOptionsV2.getTableClass()

Parameters:

tableClass - The table class.

Returns:

this

tags

@Stability(Stable)
public TablePropsV2.Builder tags(List<? extends CfnTag> tags)

Sets the value of TableOptionsV2.getTags()

Parameters:

tags - Tags to be applied to the primary table (default replica table).

Returns:

this

build

@Stability(Stable)
public TablePropsV2 build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TablePropsV2

Throws:

NullPointerException - if any required attribute was not provided