Package software.amazon.awscdk.services.dynamodb

Interface TableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SchemaOptions, TableOptions

All Known Implementing Classes:

TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:17.598Z")
@Stability(Stable)
public interface TableProps
extends software.amazon.jsii.JsiiSerializable, TableOptions

Properties for a DynamoDB Table.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.dynamodb.*;
 import software.amazon.awscdk.services.kms.Key;
 Function fn;
 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .stream(StreamViewType.NEW_IMAGE)
         .build();
 // Your self managed KMS key
 IKey myKey = Key.fromKeyArn(this, "SourceBucketEncryptionKey", "arn:aws:kms:us-east-1:123456789012:key/<key-id>");
 fn.addEventSource(DynamoEventSource.Builder.create(table)
         .startingPosition(StartingPosition.LATEST)
         .filters(List.of(FilterCriteria.filter(Map.of("eventName", FilterRule.isEqual("INSERT")))))
         .filterEncryption(myKey)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TableProps.Builder	builder()
default ApproximateCreationDateTimePrecision	getKinesisPrecisionTimestamp()	Kinesis Data Stream approximate creation timestamp precision.
default IStream	getKinesisStream()	Kinesis Data Stream to capture item-level changes for the table.
default String	getTableName()	Enforces a particular physical table name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getPartitionKey, getSortKey

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

getBillingMode, getContributorInsightsEnabled, getDeletionProtection, getEncryption, getEncryptionKey, getImportSource, getMaxReadRequestUnits, getMaxWriteRequestUnits, getPointInTimeRecovery, getReadCapacity, getRemovalPolicy, getReplicationRegions, getReplicationTimeout, getResourcePolicy, getStream, getTableClass, getTimeToLiveAttribute, getWaitForReplicationToFinish, getWarmThroughput, getWriteCapacity

Method Details

getKinesisPrecisionTimestamp

@Stability(Stable)
@Nullable
default ApproximateCreationDateTimePrecision getKinesisPrecisionTimestamp()

Kinesis Data Stream approximate creation timestamp precision.

Default: ApproximateCreationDateTimePrecision.MICROSECOND

getKinesisStream

@Stability(Stable)
@Nullable
default IStream getKinesisStream()

Kinesis Data Stream to capture item-level changes for the table.

Default: - no Kinesis Data Stream

getTableName

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

Enforces a particular physical table name.

Default:

builder

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

Returns:

a TableProps.Builder of TableProps