TableProps

class aws_cdk.aws_dynamodb.TableProps(*, partition_key, billing_mode=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, server_side_encryption=None, sort_key=None, stream=None, time_to_live_attribute=None, write_capacity=None, table_name=None)

Bases: aws_cdk.aws_dynamodb.TableOptions

__init__(*, partition_key, billing_mode=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, server_side_encryption=None, sort_key=None, stream=None, time_to_live_attribute=None, write_capacity=None, table_name=None)
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

  • 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

  • server_side_encryption (Optional[bool]) – Whether server-side encryption with an AWS managed customer master key is enabled. 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: undefined, streams are disabled

  • 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

  • table_name (Optional[str]) – Enforces a particular physical table name. Default:

Attributes

billing_mode

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

default :default: Provisioned

Return type

Optional[BillingMode]

partition_key

Partition key attribute definition.

Return type

Attribute

point_in_time_recovery

Whether point-in-time recovery is enabled.

default :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 :default: 5

Return type

Union[int, float, None]

removal_policy

The removal policy to apply to the DynamoDB Table.

default :default: RemovalPolicy.RETAIN

Return type

Optional[RemovalPolicy]

server_side_encryption

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

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

Return type

Optional[bool]

sort_key

Table sort key attribute definition.

default :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 :default: undefined, streams are disabled

Return type

Optional[StreamViewType]

table_name

Enforces a particular physical table name.

default :default:

Return type

Optional[str]

time_to_live_attribute

The name of TTL attribute.

default :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 :default: 5

Return type

Union[int, float, None]