TableProps

class aws_cdk.aws_dynamodb.TableProps(*, partition_key, sort_key=None, billing_mode=None, contributor_insights_enabled=None, deletion_protection=None, encryption=None, encryption_key=None, import_source=None, max_read_request_units=None, max_write_request_units=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, replication_regions=None, replication_timeout=None, resource_policy=None, stream=None, table_class=None, time_to_live_attribute=None, wait_for_replication_to_finish=None, write_capacity=None, kinesis_stream=None, table_name=None)

Bases: TableOptions

Properties for a DynamoDB Table.

Parameters:

partition_key (Union[Attribute, Dict[str, Any]]) – Partition key attribute definition.
sort_key (Union[Attribute, Dict[str, Any], None]) – 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
deletion_protection (Optional[bool]) – Enables deletion protection for the table. 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. .. epigraph:: 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.
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. 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.
import_source (Union[ImportSourceSpecification, Dict[str, Any], None]) – The properties of data being imported from the S3 bucket source to the table. Default: - no data import from the S3 bucket
max_read_request_units (Union[int, float, None]) – 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
max_write_request_units (Union[int, float, None]) – 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
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)
resource_policy (Optional[PolicyDocument]) – Resource policy to assign to table. Default: - No resource policy statement
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
table_class (Optional[TableClass]) – Specify the table class. Default: STANDARD
time_to_live_attribute (Optional[str]) – The name of TTL attribute. Default: - TTL is disabled
wait_for_replication_to_finish (Optional[bool]) – [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. 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:

ExampleMetadata:

infused

Example:

import aws_cdk.aws_lambda_event_sources as eventsources
import aws_cdk.aws_dynamodb as dynamodb
from aws_cdk.aws_kms import Key

# fn: lambda.Function

table = dynamodb.Table(self, "Table",
    partition_key=dynamodb.Attribute(
        name="id",
        type=dynamodb.AttributeType.STRING
    ),
    stream=dynamodb.StreamViewType.NEW_IMAGE
)
# Your self managed KMS key
my_key = Key.from_key_arn(self, "SourceBucketEncryptionKey", "arn:aws:kms:us-east-1:123456789012:key/<key-id>")

fn.add_event_source(eventsources.DynamoEventSource(table,
    starting_position=lambda_.StartingPosition.LATEST,
    filters=[lambda_.FilterCriteria.filter({"event_name": lambda_.FilterRule.is_equal("INSERT")})],
    filter_encryption=my_key
))

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

contributor_insights_enabled

Whether CloudWatch contributor insights is enabled.

Default:: false

deletion_protection

Enables deletion protection for the table.

Default:: false

encryption

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

This property cannot be set if serverSideEncryption is set. .. epigraph:

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

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

import_source

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

Default:

no data import from the S3 bucket

kinesis_stream

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

Default:

no Kinesis Data Stream

max_read_request_units

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

max_write_request_units

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

partition_key: Partition key attribute definition.

point_in_time_recovery

Whether point-in-time recovery is enabled.

Default:

point-in-time recovery is disabled

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

removal_policy

The removal policy to apply to the DynamoDB Table.

Default:: RemovalPolicy.RETAIN

replication_regions

Regions where replica tables will be created.

Default:

no replica tables are created

replication_timeout

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

Default:: Duration.minutes(30)

resource_policy

Resource policy to assign to table.

Default:

No resource policy statement

See:

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

sort_key

Sort key attribute definition.

Default:: no sort key

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

table_class

Specify the table class.

Default:: STANDARD

table_name

Enforces a particular physical table name.

Default:

time_to_live_attribute

The name of TTL attribute.

Default:

TTL is disabled

wait_for_replication_to_finish

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.

Default:: true
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
Type:: [WARNING

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