Package software.amazon.awscdk.services.dynamodb

Class TableAttributesV2.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TableAttributesV2.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TableAttributesV2>

Enclosing interface:

TableAttributesV2

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

A builder for TableAttributesV2

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

encryptionKey

@Stability(Stable)
public TableAttributesV2.Builder encryptionKey(IKey encryptionKey)

Sets the value of TableAttributesV2.getEncryptionKey()

Parameters:

encryptionKey - KMS encryption key for the table.

Returns:

this

globalIndexes

@Stability(Stable)
public TableAttributesV2.Builder globalIndexes(List<String> globalIndexes)

Sets the value of TableAttributesV2.getGlobalIndexes()

Parameters:

globalIndexes - The name of the global indexes set for the table. Note: You must set either this property or localIndexes if you want permissions to be granted for indexes as well as the table itself.

Returns:

this

grantIndexPermissions

@Stability(Stable)
public TableAttributesV2.Builder grantIndexPermissions(Boolean grantIndexPermissions)

Sets the value of TableAttributesV2.getGrantIndexPermissions()

Parameters:

grantIndexPermissions - Whether or not to grant permissions for all indexes of the table. Note: If false, permissions will only be granted to indexes when globalIndexes or localIndexes is specified.

Returns:

this

localIndexes

@Stability(Stable)
public TableAttributesV2.Builder localIndexes(List<String> localIndexes)

Sets the value of TableAttributesV2.getLocalIndexes()

Parameters:

localIndexes - The name of the local indexes set for the table. Note: You must set either this property or globalIndexes if you want permissions to be granted for indexes as well as the table itself.

Returns:

this

tableArn

@Stability(Stable)
public TableAttributesV2.Builder tableArn(String tableArn)

Sets the value of TableAttributesV2.getTableArn()

Parameters:

tableArn - The ARN of the table. Note: You must specify this or the tableName.

Returns:

this

tableId

@Stability(Stable)
public TableAttributesV2.Builder tableId(String tableId)

Sets the value of TableAttributesV2.getTableId()

Parameters:

tableId - The ID of the table.

Returns:

this

tableName

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

Sets the value of TableAttributesV2.getTableName()

Parameters:

tableName - The name of the table. Note: You must specify this or the tableArn.

Returns:

this

tableStreamArn

@Stability(Stable)
public TableAttributesV2.Builder tableStreamArn(String tableStreamArn)

Sets the value of TableAttributesV2.getTableStreamArn()

Parameters:

tableStreamArn - The stream ARN of the table.

Returns:

this

build

@Stability(Stable)
public TableAttributesV2 build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TableAttributesV2

Throws:

NullPointerException - if any required attribute was not provided