Interface GuDynamoTableProps

interface GuDynamoTableProps {
    billingMode?: BillingMode;
    contributorInsightsEnabled?: boolean;
    deletionProtection?: boolean;
    devXBackups: OptIn | OptOut;
    encryption?: TableEncryption;
    encryptionKey?: IKey;
    importSource?: ImportSourceSpecification;
    kinesisPrecisionTimestamp?: ApproximateCreationDateTimePrecision;
    kinesisStream?: IStream;
    maxReadRequestUnits?: number;
    maxWriteRequestUnits?: number;
    partitionKey: Attribute;
    pointInTimeRecovery?: boolean;
    readCapacity?: number;
    removalPolicy?: RemovalPolicy;
    replicationRegions?: string[];
    replicationTimeout?: Duration;
    resourcePolicy?: PolicyDocument;
    sortKey?: Attribute;
    stream?: StreamViewType;
    tableClass?: TableClass;
    tableName?: string;
    timeToLiveAttribute?: string;
    waitForReplicationToFinish?: boolean;
    warmThroughput?: WarmThroughput;
    writeCapacity?: number;
}

Hierarchy

TableProps
- GuDynamoTableProps

Properties

`Optional` `Readonly`billingMode

billingMode?: BillingMode

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

`Optional` `Readonly`contributorInsightsEnabled

contributorInsightsEnabled?: boolean

Whether CloudWatch contributor insights is enabled.

Default

false

`Optional` `Readonly`deletionProtection

deletionProtection?: boolean

Enables deletion protection for the table.

Default

false

devXBackups

devXBackups: OptIn | OptOut

We recommend using DevX Backups to protect your DynamoDB table's backups. For more details on this feature, see the documentation.

`Optional` `Readonly`encryption

encryption?: TableEncryption

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.

`Optional` `Readonly`encryptionKey

encryptionKey?: IKey

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.

`Optional` `Readonly`importSource

importSource?: ImportSourceSpecification

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

Default

- no data import from the S3 bucket

`Optional` `Readonly`kinesisPrecisionTimestamp

kinesisPrecisionTimestamp?: ApproximateCreationDateTimePrecision

Kinesis Data Stream approximate creation timestamp prescision

Default

ApproximateCreationDateTimePrecision.MICROSECOND

`Optional` `Readonly`kinesisStream

kinesisStream?: IStream

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

Default

- no Kinesis Data Stream

`Optional` `Readonly`maxReadRequestUnits

maxReadRequestUnits?: number

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

`Optional` `Readonly`maxWriteRequestUnits

maxWriteRequestUnits?: number

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

`Readonly`partitionKey

partitionKey: Attribute

Partition key attribute definition.

`Optional` `Readonly`pointInTimeRecovery

pointInTimeRecovery?: boolean

Whether point-in-time recovery is enabled.

Default

- point-in-time recovery is disabled

`Optional` `Readonly`readCapacity

readCapacity?: number

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

`Optional` `Readonly`removalPolicy

removalPolicy?: RemovalPolicy

The removal policy to apply to the DynamoDB Table.

Default

RemovalPolicy.RETAIN

`Optional` `Readonly`replicationRegions

replicationRegions?: string[]

Regions where replica tables will be created

Default

- no replica tables are created

`Optional` `Readonly`replicationTimeout

replicationTimeout?: Duration

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

Default

Duration.minutes(30)

`Optional` `Readonly`resourcePolicy

resourcePolicy?: PolicyDocument

Resource policy to assign to table.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-resourcepolicy

Default

- No resource policy statement

`Optional` `Readonly`sortKey

sortKey?: Attribute

Sort key attribute definition.

Default

no sort key

`Optional` `Readonly`stream

stream?: StreamViewType

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

`Optional` `Readonly`tableClass

tableClass?: TableClass

Specify the table class.

Default

STANDARD

`Optional` `Readonly`tableName

tableName?: string

Enforces a particular physical table name.

Default

<generated>

`Optional` `Readonly`timeToLiveAttribute

timeToLiveAttribute?: string

The name of TTL attribute.

Default

- TTL is disabled

`Optional` `Readonly`waitForReplicationToFinish

waitForReplicationToFinish?: boolean

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

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas

Default

true

`Optional` `Readonly`warmThroughput

warmThroughput?: WarmThroughput

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.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-warmthroughput

Default

- warm throughput is not configured

`Optional` `Readonly`writeCapacity

writeCapacity?: number

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.

Interface GuDynamoTableProps

Hierarchy

Index

Properties

Properties

Optional ReadonlybillingMode

Default

Optional ReadonlycontributorInsightsEnabled

Default

Optional ReadonlydeletionProtection

Default

devXBackups

Optional Readonlyencryption

Default

Optional ReadonlyencryptionKey

Default

Optional ReadonlyimportSource

Default

Optional ReadonlykinesisPrecisionTimestamp

Default

Optional ReadonlykinesisStream

Default

Optional ReadonlymaxReadRequestUnits

Default

Optional ReadonlymaxWriteRequestUnits

Default

ReadonlypartitionKey

Optional ReadonlypointInTimeRecovery

Default

Optional ReadonlyreadCapacity

Default

Optional ReadonlyremovalPolicy

Default

Optional ReadonlyreplicationRegions

Default

Optional ReadonlyreplicationTimeout

Default

Optional ReadonlyresourcePolicy

See

Default

Optional ReadonlysortKey

Default

Optional Readonlystream

Default

Optional ReadonlytableClass

Default

Optional ReadonlytableName

Default

Optional ReadonlytimeToLiveAttribute

Default

Optional ReadonlywaitForReplicationToFinish

See

Default

Optional ReadonlywarmThroughput

See

Default

Optional ReadonlywriteCapacity

Default

Settings

On This Page

`Optional` `Readonly`billingMode

`Optional` `Readonly`contributorInsightsEnabled

`Optional` `Readonly`deletionProtection

`Optional` `Readonly`encryption

`Optional` `Readonly`encryptionKey

`Optional` `Readonly`importSource

`Optional` `Readonly`kinesisPrecisionTimestamp

`Optional` `Readonly`kinesisStream

`Optional` `Readonly`maxReadRequestUnits

`Optional` `Readonly`maxWriteRequestUnits

`Readonly`partitionKey

`Optional` `Readonly`pointInTimeRecovery

`Optional` `Readonly`readCapacity

`Optional` `Readonly`removalPolicy

`Optional` `Readonly`replicationRegions

`Optional` `Readonly`replicationTimeout

`Optional` `Readonly`resourcePolicy

`Optional` `Readonly`sortKey

`Optional` `Readonly`stream

`Optional` `Readonly`tableClass

`Optional` `Readonly`tableName

`Optional` `Readonly`timeToLiveAttribute

`Optional` `Readonly`waitForReplicationToFinish

`Optional` `Readonly`warmThroughput

`Optional` `Readonly`writeCapacity