TableOptions

class aws_cdk.aws_dynamodb.TableOptions(*, partition_key, billing_mode=None, encryption=None, encryption_key=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, replication_regions=None, server_side_encryption=None, sort_key=None, stream=None, time_to_live_attribute=None, write_capacity=None)

Bases: object

Properties of a DynamoDB Table.

Use {@link TableProps} for all table properties

Parameters
  • partition_key (Attribute) – Partition key attribute definition.

  • 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

  • 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[List[str]]) – (experimental) Regions where replica tables will be created. Default: - no replica tables are created

  • 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

  • sort_key (Optional[Attribute]) – Table sort key attribute definition. Default: no sort 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

  • 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

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]

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]

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

(experimental) Regions where replica tables will be created.

Default
  • no replica tables are created

Stability

experimental

Return type

Optional[List[str]]

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

Table 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]

time_to_live_attribute

The name of TTL attribute.

Default
  • TTL is disabled

Return type

Optional[str]

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]