Interface TableAttributes
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
TableAttributes.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:01.155Z")
@Stability(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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forTableAttributes
static final class
An implementation forTableAttributes
-
Method Summary
Modifier and TypeMethodDescriptionstatic TableAttributes.Builder
builder()
default IKey
KMS encryption key, if this table uses a customer-managed encryption key.The name of the global indexes set for this Table.default Boolean
If set to true, grant methods always grant permissions for all indexes.The name of the local indexes set for this Table.default String
The ARN of the dynamodb table.default String
The table name of the dynamodb table.default String
The ARN of the table's stream.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEncryptionKey
KMS encryption key, if this table uses a customer-managed encryption key.Default: - no key
-
getGlobalIndexes
The name of the global indexes set for this Table.Note that you need to set either this property, or
localIndexes
, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.Default: - no global indexes
-
getGrantIndexPermissions
If set to true, grant methods always grant permissions for all indexes.If false is provided, grant methods grant the permissions only when
globalIndexes
orlocalIndexes
is specified.Default: - false
-
getLocalIndexes
The name of the local indexes set for this Table.Note that you need to set either this property, or
globalIndexes
, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.Default: - no local indexes
-
getTableArn
The ARN of the dynamodb table.One of this, or
tableName
, is required.Default: - no table arn
-
getTableName
The table name of the dynamodb table.One of this, or
tableArn
, is required.Default: - no table name
-
getTableStreamArn
The ARN of the table's stream.Default: - no table stream
-
builder
- Returns:
- a
TableAttributes.Builder
ofTableAttributes
-