All Superinterfaces:: software.amazon.jsii.JsiiSerializable, SchemaOptions

All Known Subinterfaces:: TableProps

All Known Implementing Classes:: TableOptions.Jsii$Proxy, TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)", date="2025-02-12T12:32:01.161Z") @Stability(Stable) public interface TableOptions extends software.amazon.jsii.JsiiSerializable, SchemaOptions

Properties of a DynamoDB Table.

Use TableProps for all table properties

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.dynamodb.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 InputFormat inputFormat;
 Key key;
 PolicyDocument policyDocument;
 TableOptions tableOptions = TableOptions.builder()
         .partitionKey(Attribute.builder()
                 .name("name")
                 .type(AttributeType.BINARY)
                 .build())
         // the properties below are optional
         .billingMode(BillingMode.PAY_PER_REQUEST)
         .contributorInsightsEnabled(false)
         .deletionProtection(false)
         .encryption(TableEncryption.DEFAULT)
         .encryptionKey(key)
         .importSource(ImportSourceSpecification.builder()
                 .bucket(bucket)
                 .inputFormat(inputFormat)
                 // the properties below are optional
                 .bucketOwner("bucketOwner")
                 .compressionType(InputCompressionType.GZIP)
                 .keyPrefix("keyPrefix")
                 .build())
         .maxReadRequestUnits(123)
         .maxWriteRequestUnits(123)
         .pointInTimeRecovery(false)
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecification.builder()
                 .pointInTimeRecoveryEnabled(false)
                 // the properties below are optional
                 .recoveryPeriodInDays(123)
                 .build())
         .readCapacity(123)
         .removalPolicy(RemovalPolicy.DESTROY)
         .replicationRegions(List.of("replicationRegions"))
         .replicationTimeout(Duration.minutes(30))
         .resourcePolicy(policyDocument)
         .sortKey(Attribute.builder()
                 .name("name")
                 .type(AttributeType.BINARY)
                 .build())
         .stream(StreamViewType.NEW_IMAGE)
         .tableClass(TableClass.STANDARD)
         .timeToLiveAttribute("timeToLiveAttribute")
         .waitForReplicationToFinish(false)
         .warmThroughput(WarmThroughput.builder()
                 .readUnitsPerSecond(123)
                 .writeUnitsPerSecond(123)
                 .build())
         .writeCapacity(123)
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

TableOptions.Builder

A builder for TableOptions

static final class

TableOptions.Jsii$Proxy

An implementation for TableOptions
Method Summary

Modifier and Type

Method

Description

static TableOptions.Builder

builder()

default BillingMode

getBillingMode()

Specify how you are charged for read and write throughput and how you manage capacity.

default Boolean

getContributorInsightsEnabled()

Whether CloudWatch contributor insights is enabled.

default Boolean

getDeletionProtection()

Enables deletion protection for the table.

default TableEncryption

getEncryption()

Whether server-side encryption with an AWS managed customer master key is enabled.

default IKey

getEncryptionKey()

External KMS key to use for table encryption.

default ImportSourceSpecification

getImportSource()

The properties of data being imported from the S3 bucket source to the table.

default Number

getMaxReadRequestUnits()

The maximum read request units for the table.

default Number

getMaxWriteRequestUnits()

The write request units for the table.

default Boolean

getPointInTimeRecovery()

Deprecated.
use pointInTimeRecoverySpecification instead

default PointInTimeRecoverySpecification

getPointInTimeRecoverySpecification()

Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

default Number

getReadCapacity()

The read capacity for the table.

default RemovalPolicy

getRemovalPolicy()

The removal policy to apply to the DynamoDB Table.

default List<String>

getReplicationRegions()

Regions where replica tables will be created.

default Duration

getReplicationTimeout()

The timeout for a table replication operation in a single region.

default PolicyDocument

getResourcePolicy()

Resource policy to assign to table.

default StreamViewType

getStream()

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

default TableClass

getTableClass()

Specify the table class.

default String

getTimeToLiveAttribute()

The name of TTL attribute.

default Boolean

getWaitForReplicationToFinish()

[WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish.

default WarmThroughput

getWarmThroughput()

Specify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the Table construct.

default Number

getWriteCapacity()

The write capacity for the table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.dynamodb.SchemaOptions
getPartitionKey, getSortKey

Method Details
- getBillingMode
  
  @Stability(Stable) @Nullable default BillingMode getBillingMode()
  
  Specify how you are charged for read and write throughput and how you manage capacity.
  Default: PROVISIONED if `replicationRegions` is not specified, PAY_PER_REQUEST otherwise
- getContributorInsightsEnabled
  
  @Stability(Stable) @Nullable default Boolean getContributorInsightsEnabled()
  
  Whether CloudWatch contributor insights is enabled.
  Default: false
- getDeletionProtection
  
  @Stability(Stable) @Nullable default Boolean getDeletionProtection()
  
  Enables deletion protection for the table.
  Default: false
- getEncryption
  
  @Stability(Stable) @Nullable default TableEncryption getEncryption()
  
  Whether server-side encryption with an AWS managed customer master key is enabled.
  This property cannot be set if serverSideEncryption is set.
  
  NOTE: if you set this to CUSTOMER_MANAGED and encryptionKey is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag @aws-cdk/aws-kms:defaultKeyPolicies is set to true in your cdk.json.
  
  Default: - The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
- getEncryptionKey
  
  @Stability(Stable) @Nullable default IKey getEncryptionKey()
  
  External KMS key to use for table encryption.
  This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.
  Default: - If `encryption` is set to `TableEncryption.CUSTOMER_MANAGED` and this property is undefined, a new KMS key will be created and associated with this table. If `encryption` and this property are both undefined, then the table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
- getImportSource
  
  @Stability(Stable) @Nullable default ImportSourceSpecification getImportSource()
  
  The properties of data being imported from the S3 bucket source to the table.
  Default: - no data import from the S3 bucket
- getMaxReadRequestUnits
  
  @Stability(Stable) @Nullable default Number getMaxReadRequestUnits()
  
  The maximum read request units for the table.
  Careful if you add Global Secondary Indexes, as those will share the table's maximum on-demand throughput.
  Can only be provided if billingMode is PAY_PER_REQUEST.
  Default: - on-demand throughput is disabled
- getMaxWriteRequestUnits
  
  @Stability(Stable) @Nullable default Number getMaxWriteRequestUnits()
  
  The write request units for the table.
  Careful if you add Global Secondary Indexes, as those will share the table's maximum on-demand throughput.
  Can only be provided if billingMode is PAY_PER_REQUEST.
  Default: - on-demand throughput is disabled
- getPointInTimeRecovery
  
  @Stability(Deprecated) @Deprecated @Nullable default Boolean getPointInTimeRecovery()
  
  Deprecated.
  use pointInTimeRecoverySpecification instead
  
  (deprecated) Whether point-in-time recovery is enabled.
  Default: false - point in time recovery is not enabled.
- getPointInTimeRecoverySpecification
  
  @Stability(Stable) @Nullable default PointInTimeRecoverySpecification getPointInTimeRecoverySpecification()
  
  Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.
  Default: - point in time recovery is not enabled.
- getReadCapacity
  
  @Stability(Stable) @Nullable default Number getReadCapacity()
  
  The read capacity for the table.
  Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.
  Can only be provided if billingMode is Provisioned.
  Default: 5
- getRemovalPolicy
  
  @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
  
  The removal policy to apply to the DynamoDB Table.
  Default: RemovalPolicy.RETAIN
- getReplicationRegions
  
  @Stability(Stable) @Nullable default List<String> getReplicationRegions()
  
  Regions where replica tables will be created.
  Default: - no replica tables are created
- getReplicationTimeout
  
  @Stability(Stable) @Nullable default Duration getReplicationTimeout()
  
  The timeout for a table replication operation in a single region.
  Default: Duration.minutes(30)
- getResourcePolicy
  
  @Stability(Stable) @Nullable default PolicyDocument getResourcePolicy()
  
  Resource policy to assign to table.
  Default: - No resource policy statement
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-resourcepolicy
- getStream
  
  @Stability(Stable) @Nullable default StreamViewType getStream()
  
  When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
  Default: - streams are disabled unless `replicationRegions` is specified
- getTableClass
  
  @Stability(Stable) @Nullable default TableClass getTableClass()
  
  Specify the table class.
  Default: STANDARD
- getTimeToLiveAttribute
  
  @Stability(Stable) @Nullable default String getTimeToLiveAttribute()
  
  The name of TTL attribute.
  Default: - TTL is disabled
- getWaitForReplicationToFinish
  
  @Stability(Stable) @Nullable default Boolean getWaitForReplicationToFinish()
  
  [WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish.
  If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set.
  WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion.
  If the custom resource which handles replication has a physical resource ID with the format region instead of tablename-region (this would happen if the custom resource hasn't received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted.
  Default: true
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
- getWarmThroughput
  
  @Stability(Stable) @Nullable default WarmThroughput getWarmThroughput()
  
  Specify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the Table construct.
  To enable Warm Throughput, use the TableV2 construct instead.
  Default: - warm throughput is not configured
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-warmthroughput
- getWriteCapacity
  
  @Stability(Stable) @Nullable default Number getWriteCapacity()
  
  The write capacity for the table.
  Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.
  Can only be provided if billingMode is Provisioned.
  Default: 5
- builder
  
  @Stability(Stable) static TableOptions.Builder builder()
  
  Returns:
  
  a TableOptions.Builder of TableOptions

Interface TableOptions

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Methods inherited from interface software.amazon.awscdk.services.dynamodb.SchemaOptions

Method Details

getBillingMode

getContributorInsightsEnabled

getDeletionProtection

getEncryption

getEncryptionKey

getImportSource

getMaxReadRequestUnits

getMaxWriteRequestUnits

getPointInTimeRecovery

getPointInTimeRecoverySpecification

getReadCapacity

getRemovalPolicy

getReplicationRegions

getReplicationTimeout

getResourcePolicy

getStream

getTableClass

getTimeToLiveAttribute

getWaitForReplicationToFinish

getWarmThroughput

getWriteCapacity

builder