Package software.amazon.awscdk.services.dynamodb

Interface TableAttributesV2

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
TableAttributesV2.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:00.052Z") @Stability(Stable) public interface TableAttributesV2 extends software.amazon.jsii.JsiiSerializable
Attributes of 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;
 TableAttributesV2 tableAttributesV2 = TableAttributesV2.builder()
         .encryptionKey(key)
         .globalIndexes(List.of("globalIndexes"))
         .grantIndexPermissions(false)
         .localIndexes(List.of("localIndexes"))
         .tableArn("tableArn")
         .tableId("tableId")
         .tableName("tableName")
         .tableStreamArn("tableStreamArn")
         .build();

  • Method Details

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      KMS encryption key for the table.

      Default: - no KMS encryption key

    • getGlobalIndexes

      @Stability(Stable) @Nullable default List<String> getGlobalIndexes()
      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.

      Default: - no global indexes

    • getGrantIndexPermissions

      @Stability(Stable) @Nullable default Boolean getGrantIndexPermissions()
      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.

      Default: false

    • getLocalIndexes

      @Stability(Stable) @Nullable default List<String> getLocalIndexes()
      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.

      Default: - no local indexes

    • getTableArn

      @Stability(Stable) @Nullable default String getTableArn()
      The ARN of the table.

      Note: You must specify this or the tableName.

      Default: - table arn generated using `tableName` and region of stack

    • getTableId

      @Stability(Stable) @Nullable default String getTableId()
      The ID of the table.

      Default: - no table id

    • getTableName

      @Stability(Stable) @Nullable default String getTableName()
      The name of the table.

      Note: You must specify this or the tableArn.

      Default: - table name retrieved from provided `tableArn`

    • getTableStreamArn

      @Stability(Stable) @Nullable default String getTableStreamArn()
      The stream ARN of the table.

      Default: - no table stream ARN

    • builder

      @Stability(Stable) static TableAttributesV2.Builder builder()
      Returns:
      a TableAttributesV2.Builder of TableAttributesV2