Interface TableOptions

Properties of a DynamoDB Table.

Use TableProps for all table properties

Synopsis

Properties

billingMode	Specify how you are charged for read and write throughput and how you manage capacity.
encryption	Whether server-side encryption with an AWS managed customer master key is enabled.
encryptionKey	External KMS key to use for table encryption.
partitionKey	Partition key attribute definition.
pointInTimeRecovery	Whether point-in-time recovery is enabled.
readCapacity	The read capacity for the table.
removalPolicy	The removal policy to apply to the DynamoDB Table.
replicationRegions	(experimental) Regions where replica tables will be created.
serverSideEncryption	(deprecated) Whether server-side encryption with an AWS managed customer master key is enabled.
sortKey	Table sort key attribute definition.
stream	When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
timeToLiveAttribute	The name of TTL attribute.
writeCapacity	The write capacity for the table.

Properties

billingMode

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

PROVISIONED if replicationRegions is not specified, PAY_PER_REQUEST otherwise

Declaration

readonly billingMode?: BillingMode;

Property Value

BillingMode

encryption

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

This property cannot be set if serverSideEncryption is set.

• server-side encryption is enabled with an AWS owned customer master key

Declaration

readonly encryption?: TableEncryption;

Property Value

TableEncryption

encryptionKey

External KMS key to use for table encryption.

This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

• 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.

Declaration

readonly encryptionKey?: kms.IKey;

Property Value

kms.IKey

partitionKey

Partition key attribute definition.

Declaration

readonly partitionKey: Attribute;

Property Value

Attribute

pointInTimeRecovery

Whether point-in-time recovery is enabled.

• point-in-time recovery is disabled

Declaration

readonly pointInTimeRecovery?: boolean;

Property Value

boolean

readCapacity

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.

5

Declaration

readonly readCapacity?: number;

Property Value

number

removalPolicy

The removal policy to apply to the DynamoDB Table.

RemovalPolicy.RETAIN

Declaration

readonly removalPolicy?: RemovalPolicy;

Property Value

RemovalPolicy

replicationRegions

(experimental) Regions where replica tables will be created.

• no replica tables are created

Declaration

readonly replicationRegions?: string[];

Property Value

string[]

serverSideEncryption

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

This property cannot be set if encryption and/or encryptionKey is set.

• server-side encryption is enabled with an AWS owned customer master key

Declaration

readonly serverSideEncryption?: boolean;

Property Value

boolean

sortKey

Table sort key attribute definition.

no sort key

Declaration

readonly sortKey?: Attribute;

Property Value

Attribute

stream

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

• streams are disabled unless replicationRegions is specified

Declaration

readonly stream?: StreamViewType;

Property Value

StreamViewType

timeToLiveAttribute

The name of TTL attribute.

• TTL is disabled

Declaration

readonly timeToLiveAttribute?: string;

Property Value

string

writeCapacity

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.

5

Declaration

readonly writeCapacity?: number;

Property Value

number