GlobalTable

class aws_cdk.aws_dynamodb_global.GlobalTable(scope, id, *, regions, table_name, 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)

Bases: aws_cdk.core.Construct

This class works by deploying an AWS DynamoDB table into each region specified in GlobalTableProps.regions[], then triggering a CloudFormation Custom Resource Lambda to link them all together to create linked AWS Global DynamoDB tables.

deprecated :deprecated: use @aws-cdk/aws-dynamodb.Table.replicationRegions instead

stability :stability: deprecated

__init__(scope, id, *, regions, table_name, 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)
Parameters
  • scope (Construct) –

  • id (str) –

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

  • 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

stability :stability: deprecated

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

regional_tables

Obtain tables deployed in other each region.

stability :stability: deprecated

Return type

List[Table]

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool