Package software.amazon.awscdk.services.dynamodb

Interface TableGrantsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TableGrantsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:18.560Z")
@Stability(Stable)
public interface TableGrantsProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for TableGrants.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.interfaces.dynamodb.*;
 IEncryptedResource encryptedResource;
 IResourceWithPolicyV2 resourceWithPolicyV2;
 ITableRef tableRef;
 TableGrantsProps tableGrantsProps = TableGrantsProps.builder()
         .table(tableRef)
         // the properties below are optional
         .encryptedResource(encryptedResource)
         .hasIndex(false)
         .policyResource(resourceWithPolicyV2)
         .regions(List.of("regions"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TableGrantsProps.Builder	A builder for TableGrantsProps
static final class	TableGrantsProps.Jsii$Proxy	An implementation for TableGrantsProps

Method Summary

Modifier and Type	Method	Description
static TableGrantsProps.Builder	builder()
default IEncryptedResource	getEncryptedResource()	The encrypted resource on which actions will be allowed.
default Boolean	getHasIndex()	Whether this table has indexes.
default IResourceWithPolicyV2	getPolicyResource()	The resource with policy on which actions will be allowed.
default List<String>	getRegions()	Additional regions other than the main one that this table is replicated to.
ITableRef	getTable()	The table to grant permissions on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTable

@Stability(Stable)
@NotNull
ITableRef getTable()

The table to grant permissions on.

getEncryptedResource

@Stability(Stable)
@Nullable
default IEncryptedResource getEncryptedResource()

The encrypted resource on which actions will be allowed.

Default: - No permission is added to the KMS key, even if it exists

getHasIndex

@Stability(Stable)
@Nullable
default Boolean getHasIndex()

Whether this table has indexes.

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

Default: false

getPolicyResource

@Stability(Stable)
@Nullable
default IResourceWithPolicyV2 getPolicyResource()

The resource with policy on which actions will be allowed.

Default: - No resource policy is created

getRegions

@Stability(Stable)
@Nullable
default List<String> getRegions()

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

Default: - No regions

builder

@Stability(Stable)
static TableGrantsProps.Builder builder()

Returns:

a TableGrantsProps.Builder of TableGrantsProps