software.amazon.awscdk.services.dynamodb

Interface TableAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TableAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.082Z")
 @Stability(value=Stable)
public interface TableAttributes
extends software.amazon.jsii.JsiiSerializable

Reference to a dynamodb table.

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.kms.*;
 Key key;
 TableAttributes tableAttributes = TableAttributes.builder()
         .encryptionKey(key)
         .globalIndexes(List.of("globalIndexes"))
         .grantIndexPermissions(false)
         .localIndexes(List.of("localIndexes"))
         .tableArn("tableArn")
         .tableName("tableName")
         .tableStreamArn("tableStreamArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TableAttributes.Builder	builder()
default IKey	getEncryptionKey() KMS encryption key, if this table uses a customer-managed encryption key.
default List<String>	getGlobalIndexes() The name of the global indexes set for this Table.
default Boolean	getGrantIndexPermissions() If set to true, grant methods always grant permissions for all indexes.
default List<String>	getLocalIndexes() The name of the local indexes set for this Table.
default String	getTableArn() The ARN of the dynamodb table.
default String	getTableName() The table name of the dynamodb table.
default String	getTableStreamArn() The ARN of the table's stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

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

Default: - no key

getGlobalIndexes

@Stability(value=Stable)
 @Nullable
default List<String> getGlobalIndexes()

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.

Default: - no global indexes

getGrantIndexPermissions

@Stability(value=Stable)
 @Nullable
default Boolean getGrantIndexPermissions()

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.

Default: - false

getLocalIndexes

@Stability(value=Stable)
 @Nullable
default List<String> getLocalIndexes()

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.

Default: - no local indexes

getTableArn

@Stability(value=Stable)
 @Nullable
default String getTableArn()

The ARN of the dynamodb table.

One of this, or {@link tableName}, is required.

Default: - no table arn

getTableName

@Stability(value=Stable)
 @Nullable
default String getTableName()

The table name of the dynamodb table.

One of this, or {@link tableArn}, is required.

Default: - no table name

getTableStreamArn

@Stability(value=Stable)
 @Nullable
default String getTableStreamArn()

The ARN of the table's stream.

Default: - no table stream

builder

@Stability(value=Stable)
static TableAttributes.Builder builder()

Returns:

a TableAttributes.Builder of TableAttributes