Package software.amazon.awscdk.services.dynamodb

Class TableGrants.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.TableGrants.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TableGrants>

Enclosing class:

TableGrants

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

A fluent builder for TableGrants.

Method Summary

Modifier and Type	Method	Description
TableGrants	build()
static TableGrants.Builder	create()
TableGrants.Builder	encryptedResource(IEncryptedResource encryptedResource)	Deprecated. Leave this field undefined.
TableGrants.Builder	hasIndex(Boolean hasIndex)	Whether this table has indexes.
TableGrants.Builder	policyResource(IResourceWithPolicyV2 policyResource)	Deprecated. Leave this field undefined.
TableGrants.Builder	regions(List<String> regions)	Additional regions other than the main one that this table is replicated to.
TableGrants.Builder	table(ITableRef table)	The table to grant permissions on.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static TableGrants.Builder create()

Returns:

a new instance of TableGrants.Builder.

table

@Stability(Stable)
public TableGrants.Builder table(ITableRef table)

The table to grant permissions on.

Parameters:

table - The table to grant permissions on. This parameter is required.

Returns:

this

encryptedResource

@Stability(Deprecated)
@Deprecated
public TableGrants.Builder encryptedResource(IEncryptedResource encryptedResource)

Deprecated.

• Leave this field undefined. If the table is encrypted with a customer-managed KMS key, appropriate grants to the key will be automatically added.

(deprecated) The encrypted resource on which actions will be allowed.

Default: - A best-effort attempt will be made to discover an associated KMS key and grant permissions to it.

Parameters:

encryptedResource - The encrypted resource on which actions will be allowed. This parameter is required.

Returns:

this

hasIndex

@Stability(Stable)
public TableGrants.Builder hasIndex(Boolean hasIndex)

Whether this table has indexes.

If so, permissions are granted on all table indexes as well.

Default: false

Parameters:

hasIndex - Whether this table has indexes. This parameter is required.

Returns:

this

policyResource

@Stability(Deprecated)
@Deprecated
public TableGrants.Builder policyResource(IResourceWithPolicyV2 policyResource)

Deprecated.

• Leave this field undefined. A best-effort attempt will be made to discover a resource policy and add permissions to it.

(deprecated) The resource with policy on which actions will be allowed.

Default: - A best-effort attempt will be made to discover a resource policy and add permissions to it.

Parameters:

policyResource - The resource with policy on which actions will be allowed. This parameter is required.

Returns:

this

regions

@Stability(Stable)
public TableGrants.Builder regions(List<String> regions)

Additional regions other than the main one that this table is replicated to.

Default: - No regions

Parameters:

regions - Additional regions other than the main one that this table is replicated to. This parameter is required.

Returns:

this

build

@Stability(Stable)
public TableGrants build()

Specified by:

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

Returns:

a newly built instance of TableGrants.