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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.300Z")
@Stability(Stable)
public interface TableProps
extends software.amazon.jsii.JsiiSerializable, TableOptions

Properties for a DynamoDB Table.

Example:

 Table globalTable = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .replicationRegions(List.of("us-east-1", "us-east-2", "us-west-2"))
         .billingMode(BillingMode.PROVISIONED)
         .build();
 globalTable.autoScaleWriteCapacity(EnableScalingProps.builder()
         .minCapacity(1)
         .maxCapacity(10)
         .build()).scaleOnUtilization(UtilizationScalingProps.builder().targetUtilizationPercent(75).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, getEncryption, getEncryptionKey, getPointInTimeRecovery, getReadCapacity, getRemovalPolicy, getReplicationRegions, getReplicationTimeout, getServerSideEncryption, 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