TableProps¶

class aws_cdk.aws_dynamodb.TableProps(*, partition_key, sort_key=None, billing_mode=None, contributor_insights_enabled=None, encryption=None, encryption_key=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, replication_regions=None, replication_timeout=None, server_side_encryption=None, stream=None, time_to_live_attribute=None, wait_for_replication_to_finish=None, write_capacity=None, kinesis_stream=None, table_name=None)¶

Bases: aws_cdk.aws_dynamodb.TableOptions

Properties for a DynamoDB Table.

Parameters

partition_key (Attribute) – Partition key attribute definition.
sort_key (Optional[Attribute]) – Sort key attribute definition. Default: no sort key
billing_mode (Optional[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
contributor_insights_enabled (Optional[bool]) – Whether CloudWatch contributor insights is enabled. Default: false
encryption (Optional[TableEncryption]) – Whether server-side encryption with an AWS managed customer master key is enabled. This property cannot be set if serverSideEncryption is set. Default: - server-side encryption is enabled with an AWS owned customer master key
encryption_key (Optional[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.
point_in_time_recovery (Optional[bool]) – Whether point-in-time recovery is enabled. Default: - point-in-time recovery is disabled
read_capacity (Union[int, float, None]) – 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: 5
removal_policy (Optional[RemovalPolicy]) – The removal policy to apply to the DynamoDB Table. Default: RemovalPolicy.RETAIN
replication_regions (Optional[Sequence[str]]) – Regions where replica tables will be created. Default: - no replica tables are created
replication_timeout (Optional[Duration]) – The timeout for a table replication operation in a single region. Default: Duration.minutes(30)
server_side_encryption (Optional[bool]) – (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. Default: - server-side encryption is enabled with an AWS owned customer master key
stream (Optional[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
time_to_live_attribute (Optional[str]) – The name of TTL attribute. Default: - TTL is disabled
wait_for_replication_to_finish (Optional[bool]) – 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. 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. Default: true
write_capacity (Union[int, float, None]) – 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. Default: 5
kinesis_stream (Optional[IStream]) – Kinesis Data Stream to capture item-level changes for the table. Default: - no Kinesis Data Stream
table_name (Optional[str]) – Enforces a particular physical table name. Default:

Example:

global_table = dynamodb.Table(self, "Table",
    partition_key=dynamodb.Attribute(name="id", type=dynamodb.AttributeType.STRING),
    replication_regions=["us-east-1", "us-east-2", "us-west-2"],
    billing_mode=dynamodb.BillingMode.PROVISIONED
)

global_table.auto_scale_write_capacity(
    min_capacity=1,
    max_capacity=10
).scale_on_utilization(target_utilization_percent=75)

Attributes

billing_mode¶

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
Return type: Optional[BillingMode]

contributor_insights_enabled¶

Whether CloudWatch contributor insights is enabled.

Default: false
Return type: Optional[bool]

encryption¶

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

This property cannot be set if serverSideEncryption is set.

Default

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

Return type

Optional[TableEncryption]

encryption_key¶

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.

Return type: Optional[IKey]

kinesis_stream¶

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

Default

no Kinesis Data Stream

Return type

Optional[IStream]

partition_key¶

Partition key attribute definition.

Return type: Attribute

point_in_time_recovery¶

Whether point-in-time recovery is enabled.

Default

point-in-time recovery is disabled

Return type

Optional[bool]

read_capacity¶

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: 5
Return type: Union[int, float, None]

removal_policy¶

The removal policy to apply to the DynamoDB Table.

Default: RemovalPolicy.RETAIN
Return type: Optional[RemovalPolicy]

replication_regions¶

Regions where replica tables will be created.

Default

no replica tables are created

Return type

Optional[List[str]]

replication_timeout¶

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

Default: Duration.minutes(30)
Return type: Optional[Duration]

server_side_encryption¶

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

Default

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

Deprecated

This property is deprecated. In order to obtain the same behavior as enabling this, set the encryption property to TableEncryption.AWS_MANAGED instead.

Stability: deprecated
Return type: Optional[bool]

sort_key¶

Sort key attribute definition.

Default: no sort key
Return type: Optional[Attribute]

stream¶

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

Return type

Optional[StreamViewType]

table_name¶

Enforces a particular physical table name.

Default
Return type: Optional[str]

time_to_live_attribute¶

The name of TTL attribute.

Default

TTL is disabled

Return type

Optional[str]

wait_for_replication_to_finish¶

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.

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.

Default: true
See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
Return type: Optional[bool]

write_capacity¶

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.

Default: 5
Return type: Union[int, float, None]