GlobalTableProps¶

class aws_cdk.aws_dynamodb_global.GlobalTableProps(*, analytics_reporting=None, description=None, env=None, stack_name=None, synthesizer=None, tags=None, termination_protection=None, partition_key, sort_key=None, billing_mode=None, contributor_insights_enabled=None, encryption=None, encryption_key=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, replication_regions=None, replication_timeout=None, server_side_encryption=None, stream=None, table_class=None, time_to_live_attribute=None, wait_for_replication_to_finish=None, write_capacity=None, regions, table_name)¶

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

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

Parameters

analytics_reporting (Optional[bool]) – Include runtime versioning information in this Stack. Default: analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key
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. Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks). If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there. If either region or account are not set nor inherited from Stage, the Stack will be considered “environment-agnostic””. Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment’s AWS partition, and other such enhancements. Default: - The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
stack_name (Optional[str]) – Name to deploy the stack with. Default: - Derived from construct path.
synthesizer (Optional[IStackSynthesizer]) – Synthesis method to use while deploying this stack. Default: - DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.
tags (Optional[Mapping[str, str]]) – Stack tags that will be applied to all the taggable resources and the stack itself. Default: {}
termination_protection (Optional[bool]) – Whether to enable termination protection for this stack. Default: false
partition_key (Attribute) – Partition key attribute definition.
sort_key (Optional[Attribute]) – 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
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: - 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[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)
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
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]) – 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. 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. 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
regions (Sequence[str]) – (deprecated) Array of environments to create DynamoDB tables in. The tables will all be created in the same account.
table_name (str) – (deprecated) Name of the DynamoDB table to use across all regional tables. This is required for global tables.

Stability

deprecated

ExampleMetadata

infused

Example:

from aws_cdk.aws_dynamodb import Attribute
from aws_cdk.aws_dynamodb import AttributeType
from aws_cdk.aws_dynamodb_global import GlobalTable
from aws_cdk.core import App

app = App()
GlobalTable(app, "globdynamodb",
    partition_key=Attribute(name="hashKey", type=AttributeType.STRING),
    table_name="GlobalTable",
    regions=["us-east-1", "us-east-2", "us-west-2"]
)
app.synth()

Attributes

analytics_reporting¶

Include runtime versioning information in this Stack.

Default

analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key

Return type: Optional[bool]

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]

contributor_insights_enabled¶

Whether CloudWatch contributor insights is enabled.

Default: false
Return type: Optional[bool]

description¶

A description of the stack.

Default

No description.

Return type

Optional[str]

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

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]

env¶

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

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered “environment-agnostic””. Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment’s AWS partition, and other such enhancements.

Default

The environment of the containing Stage if available,

otherwise create the stack will be environment-agnostic.

Example:

# Use a concrete account and region to deploy this stack to:
# `.account` and `.region` will simply return these values.
Stack(app, "Stack1",
    env=Environment(
        account="123456789012",
        region="us-east-1"
    )
)

# Use the CLI's current credentials to determine the target environment:
# `.account` and `.region` will reflect the account+region the CLI
# is configured to use (based on the user CLI credentials)
Stack(app, "Stack2",
    env=Environment(
        account=process.env.CDK_DEFAULT_ACCOUNT,
        region=process.env.CDK_DEFAULT_REGION
    )
)

# Define multiple stacks stage associated with an environment
my_stage = Stage(app, "MyStage",
    env=Environment(
        account="123456789012",
        region="us-east-1"
    )
)

# both of these stacks will use the stage's account/region:
# `.account` and `.region` will resolve to the concrete values as above
MyStack(my_stage, "Stack1")
YourStack(my_stage, "Stack2")

# Define an environment-agnostic stack:
# `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
# which will only resolve to actual values by CloudFormation during deployment.
MyStack(app, "Stack1")

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

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]

regions¶

(deprecated) Array of environments to create DynamoDB tables in.

The tables will all be created in the same account.

Stability: deprecated
Return type: List[str]

removal_policy¶

The removal policy to apply to the DynamoDB Table.

Default: RemovalPolicy.RETAIN
Return type: Optional[RemovalPolicy]

replication_regions¶

Regions where replica tables will be created.

Default

no replica tables are created

Return type

Optional[List[str]]

replication_timeout¶

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

Default: Duration.minutes(30)
Return type: Optional[Duration]

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¶

Sort key attribute definition.

Default: no sort key
Return type: Optional[Attribute]

stack_name¶

Name to deploy the stack with.

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

streams are disabled unless replicationRegions is specified

Return type

Optional[StreamViewType]

synthesizer¶

Synthesis method to use while deploying this stack.

Default

DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag

is set, LegacyStackSynthesizer otherwise.

Return type: Optional[IStackSynthesizer]

table_class¶

Specify the table class.

Default: STANDARD
Return type: Optional[TableClass]

table_name¶

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

This is required for global tables.

Stability: deprecated
Return type: str

tags¶

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

Default: {}
Return type: Optional[Mapping[str, str]]

termination_protection¶

Whether to enable termination protection for this stack.

Default: false
Return type: Optional[bool]

time_to_live_attribute¶

The name of TTL attribute.

Default

TTL is disabled

Return type

Optional[str]

wait_for_replication_to_finish¶

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.

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.

Default: true
See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
Return type: Optional[bool]

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]