Package software.amazon.awscdk.services.dynamodb

Class ReplicaTableProps.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.ReplicaTableProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReplicaTableProps>

Enclosing interface:

ReplicaTableProps

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

A builder for ReplicaTableProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReplicaTableProps	build()	Builds the configured instance.
ReplicaTableProps.Builder	contributorInsights(Boolean contributorInsights)	Sets the value of TableOptionsV2.getContributorInsights()
ReplicaTableProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of TableOptionsV2.getDeletionProtection()
ReplicaTableProps.Builder	globalSecondaryIndexOptions(Map<String,? extends ReplicaGlobalSecondaryIndexOptions> globalSecondaryIndexOptions)	Sets the value of ReplicaTableProps.getGlobalSecondaryIndexOptions()
ReplicaTableProps.Builder	kinesisStream(IStream kinesisStream)	Sets the value of TableOptionsV2.getKinesisStream()
ReplicaTableProps.Builder	maxReadRequestUnits(Number maxReadRequestUnits)	Sets the value of ReplicaTableProps.getMaxReadRequestUnits()
ReplicaTableProps.Builder	pointInTimeRecovery(Boolean pointInTimeRecovery)	Deprecated. use `pointInTimeRecoverySpecification` instead
ReplicaTableProps.Builder	pointInTimeRecoverySpecification(PointInTimeRecoverySpecification pointInTimeRecoverySpecification)	Sets the value of TableOptionsV2.getPointInTimeRecoverySpecification()
ReplicaTableProps.Builder	readCapacity(Capacity readCapacity)	Sets the value of ReplicaTableProps.getReadCapacity()
ReplicaTableProps.Builder	region(String region)	Sets the value of ReplicaTableProps.getRegion()
ReplicaTableProps.Builder	resourcePolicy(PolicyDocument resourcePolicy)	Sets the value of TableOptionsV2.getResourcePolicy()
ReplicaTableProps.Builder	tableClass(TableClass tableClass)	Sets the value of TableOptionsV2.getTableClass()
ReplicaTableProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of TableOptionsV2.getTags()

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

region

@Stability(Stable)
public ReplicaTableProps.Builder region(String region)

Sets the value of ReplicaTableProps.getRegion()

Parameters:

region - The region that the replica table will be created in. This parameter is required.

Returns:

this

globalSecondaryIndexOptions

@Stability(Stable)
public ReplicaTableProps.Builder globalSecondaryIndexOptions(Map<String,? extends ReplicaGlobalSecondaryIndexOptions> globalSecondaryIndexOptions)

Sets the value of ReplicaTableProps.getGlobalSecondaryIndexOptions()

Parameters:

globalSecondaryIndexOptions - Options used to configure global secondary index properties.

Returns:

this

maxReadRequestUnits

@Stability(Stable)
public ReplicaTableProps.Builder maxReadRequestUnits(Number maxReadRequestUnits)

Sets the value of ReplicaTableProps.getMaxReadRequestUnits()

Parameters:

maxReadRequestUnits - The maximum read request units. Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

Returns:

this

readCapacity

@Stability(Stable)
public ReplicaTableProps.Builder readCapacity(Capacity readCapacity)

Sets the value of ReplicaTableProps.getReadCapacity()

Parameters:

readCapacity - The read capacity. Note: This can only be configured if the primary table billing is provisioned.

Returns:

this

contributorInsights

@Stability(Stable)
public ReplicaTableProps.Builder contributorInsights(Boolean contributorInsights)

Sets the value of TableOptionsV2.getContributorInsights()

Parameters:

contributorInsights - Whether CloudWatch contributor insights is enabled.

Returns:

this

deletionProtection

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

Sets the value of TableOptionsV2.getDeletionProtection()

Parameters:

deletionProtection - Whether deletion protection is enabled.

Returns:

this

kinesisStream

@Stability(Stable)
public ReplicaTableProps.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 ReplicaTableProps.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 ReplicaTableProps.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 ReplicaTableProps.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 ReplicaTableProps.Builder tableClass(TableClass tableClass)

Sets the value of TableOptionsV2.getTableClass()

Parameters:

tableClass - The table class.

Returns:

this

tags

@Stability(Stable)
public ReplicaTableProps.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 ReplicaTableProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ReplicaTableProps

Throws:

NullPointerException - if any required attribute was not provided