software.amazon.awscdk.services.dynamodb

Class TableAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TableAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TableAttributes>

Enclosing interface:

TableAttributes

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

A builder for TableAttributes

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TableAttributes	build() Builds the configured instance.
TableAttributes.Builder	encryptionKey(IKey encryptionKey) Sets the value of TableAttributes.getEncryptionKey()
TableAttributes.Builder	globalIndexes(List<String> globalIndexes) Sets the value of TableAttributes.getGlobalIndexes()
TableAttributes.Builder	grantIndexPermissions(Boolean grantIndexPermissions) Sets the value of TableAttributes.getGrantIndexPermissions()
TableAttributes.Builder	localIndexes(List<String> localIndexes) Sets the value of TableAttributes.getLocalIndexes()
TableAttributes.Builder	tableArn(String tableArn) Sets the value of TableAttributes.getTableArn()
TableAttributes.Builder	tableName(String tableName) Sets the value of TableAttributes.getTableName()
TableAttributes.Builder	tableStreamArn(String tableStreamArn) Sets the value of TableAttributes.getTableStreamArn()

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

encryptionKey

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

Sets the value of TableAttributes.getEncryptionKey()

Parameters:

encryptionKey - KMS encryption key, if this table uses a customer-managed encryption key.

Returns:

this

globalIndexes

@Stability(value=Stable)
public TableAttributes.Builder globalIndexes(List<String> globalIndexes)

Sets the value of TableAttributes.getGlobalIndexes()

Parameters:

globalIndexes - The name of the global indexes set for this Table. Note that you need to set either this property, or {@link localIndexes}, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

Returns:

this

grantIndexPermissions

@Stability(value=Stable)
public TableAttributes.Builder grantIndexPermissions(Boolean grantIndexPermissions)

Sets the value of TableAttributes.getGrantIndexPermissions()

Parameters:

grantIndexPermissions - If set to true, grant methods always grant permissions for all indexes. If false is provided, grant methods grant the permissions only when {@link globalIndexes} or {@link localIndexes} is specified.

Returns:

this

localIndexes

@Stability(value=Stable)
public TableAttributes.Builder localIndexes(List<String> localIndexes)

Sets the value of TableAttributes.getLocalIndexes()

Parameters:

localIndexes - The name of the local indexes set for this Table. Note that you need to set either this property, or {@link globalIndexes}, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

Returns:

this

tableArn

@Stability(value=Stable)
public TableAttributes.Builder tableArn(String tableArn)

Sets the value of TableAttributes.getTableArn()

Parameters:

tableArn - The ARN of the dynamodb table. One of this, or {@link tableName}, is required.

Returns:

this

tableName

@Stability(value=Stable)
public TableAttributes.Builder tableName(String tableName)

Sets the value of TableAttributes.getTableName()

Parameters:

tableName - The table name of the dynamodb table. One of this, or {@link tableArn}, is required.

Returns:

this

tableStreamArn

@Stability(value=Stable)
public TableAttributes.Builder tableStreamArn(String tableStreamArn)

Sets the value of TableAttributes.getTableStreamArn()

Parameters:

tableStreamArn - The ARN of the table's stream.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TableAttributes

Throws:

NullPointerException - if any required attribute was not provided