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.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.571Z")
@Stability(Stable)
public interface TableProps
extends software.amazon.jsii.JsiiSerializable, TableOptions

Properties for a DynamoDB Table.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.s3.*;
 IBucket bucket;
 App app = new App();
 Stack stack = new Stack(app, "Stack");
 Table.Builder.create(stack, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .importSource(ImportSourceSpecification.builder()
                 .compressionType(InputCompressionType.GZIP)
                 .inputFormat(InputFormat.csv(CsvOptions.builder()
                         .delimiter(",")
                         .headerList(List.of("id", "name"))
                         .build()))
                 .bucket(bucket)
                 .keyPrefix("prefix")
                 .build())
         .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 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, getPointInTimeRecovery, getReadCapacity, getRemovalPolicy, getReplicationRegions, getReplicationTimeout, getStream, getTableClass, getTimeToLiveAttribute, getWaitForReplicationToFinish, getWriteCapacity

Method Details

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