GlobalTableProps

class aws_cdk.aws_dynamodb_global.GlobalTableProps(*, description=None, env=None, stack_name=None, tags=None, partition_key, billing_mode=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, regions, table_name)

Bases: aws_cdk.core.StackProps, aws_cdk.aws_dynamodb.TableOptions

__init__(*, description=None, env=None, stack_name=None, tags=None, partition_key, billing_mode=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, regions, table_name)

Properties for the multiple DynamoDB tables to mash together into a global table.

Parameters
  • description (Optional[str]) – A description of the stack. Default: - No description.

  • env (Optional[Environment]) – The AWS environment (account/region) where this stack will be deployed. Default: - The default-account and default-region context parameters will be used. If they are undefined, it will not be possible to deploy the stack.

  • stack_name (Optional[str]) – Name to deploy the stack with. Default: - Derived from construct path.

  • tags (Optional[Mapping[str, str]]) – Stack tags that will be applied to all the taggable resources and the stack itself. Default: {}

  • 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

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

  • 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: - 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

  • regions (List[str]) – Array of environments to create DynamoDB tables in. The tables will all be created in the same account.

  • table_name (str) – Name of the DynamoDB table to use across all regional tables. This is required for global tables.

stability :stability: deprecated

Attributes

billing_mode

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

default :default: PROVISIONED if replicationRegions is not specified, PAY_PER_REQUEST otherwise

Return type

Optional[BillingMode]

description

A description of the stack.

default :default: - No description.

Return type

Optional[str]

env

The AWS environment (account/region) where this stack will be deployed.

default :default:

  • The default-account and default-region context parameters will be used. If they are undefined, it will not be possible to deploy the stack.

Return type

Optional[Environment]

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]

regions

Array of environments to create DynamoDB tables in.

The tables will all be created in the same account.

stability :stability: deprecated

Return type

List[str]

removal_policy

The removal policy to apply to the DynamoDB Table.

default :default: RemovalPolicy.RETAIN

Return type

Optional[RemovalPolicy]

replication_regions

Regions where replica tables will be created.

default :default: - no replica tables are created

stability :stability: experimental

Return type

Optional[List[str]]

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]

stack_name

Name to deploy the stack with.

default :default: - Derived from construct path.

Return type

Optional[str]

stream

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

default :default: - streams are disabled unless replicationRegions is specified

Return type

Optional[StreamViewType]

table_name

Name of the DynamoDB table to use across all regional tables.

This is required for global tables.

stability :stability: deprecated

Return type

str

tags

Stack tags that will be applied to all the taggable resources and the stack itself.

default :default: {}

Return type

Optional[Mapping[str, 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]