AWS CDK Reference

Appearance

v2.274.0

CfnGlobalTablePropsMixin Mixin ​

The AWS::DynamoDB::GlobalTable resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table. For more information, see Global tables .

You cannot convert a resource of type AWS::DynamoDB::Table into a resource of type AWS::DynamoDB::GlobalTable by changing its type in your template. Doing so might result in the deletion of your DynamoDB table.

You can instead use the GlobalTable resource to create a new table in a single Region. This will be billed the same as a single Region table. If you later update the stack to add other Regions then Global Tables pricing will apply.

You should be aware of the following behaviors when working with DynamoDB global tables.

  • The IAM Principal executing the stack operation must have the permissions listed below in all regions where you plan to have a global table replica. The IAM Principal's permissions should not have restrictions based on IP source address. Some global tables operations (for example, adding a replica) are asynchronous, and require that the IAM Principal is valid until they complete. You should not delete the Principal (user or IAM role) until CloudFormation has finished updating your stack.

  • application-autoscaling:DeleteScalingPolicy

  • application-autoscaling:DeleteScheduledAction

  • application-autoscaling:DeregisterScalableTarget

  • application-autoscaling:DescribeScalableTargets

  • application-autoscaling:DescribeScalingPolicies

  • application-autoscaling:PutScalingPolicy

  • application-autoscaling:PutScheduledAction

  • application-autoscaling:RegisterScalableTarget

  • dynamodb:BatchWriteItem

  • dynamodb:CreateGlobalTableWitness

  • dynamodb:CreateTable

  • dynamodb:CreateTableReplica

  • dynamodb:DeleteGlobalTableWitness

  • dynamodb:DeleteItem

  • dynamodb:DeleteTable

  • dynamodb:DeleteTableReplica

  • dynamodb:DescribeContinuousBackups

  • dynamodb:DescribeContributorInsights

  • dynamodb:DescribeTable

  • dynamodb:DescribeTableReplicaAutoScaling

  • dynamodb:DescribeTimeToLive

  • dynamodb:DisableKinesisStreamingDestination

  • dynamodb:EnableKinesisStreamingDestination

  • dynamodb:GetItem

  • dynamodb:ListTables

  • dynamodb:ListTagsOfResource

  • dynamodb:PutItem

  • dynamodb:Query

  • dynamodb:Scan

  • dynamodb:TagResource

  • dynamodb:UntagResource

  • dynamodb:UpdateContinuousBackups

  • dynamodb:UpdateContributorInsights

  • dynamodb:UpdateItem

  • dynamodb:UpdateTable

  • dynamodb:UpdateTableReplicaAutoScaling

  • dynamodb:UpdateTimeToLive

  • iam:CreateServiceLinkedRole

  • kms:CreateGrant

  • kms:DescribeKey

  • When using provisioned billing mode, CloudFormation will create an auto scaling policy on each of your replicas to control their write capacities. You must configure this policy using the WriteProvisionedThroughputSettings property. CloudFormation will ensure that all replicas have the same write capacity auto scaling property. You cannot directly specify a value for write capacity for a global table.

  • If your table uses provisioned capacity, you must configure auto scaling directly in the AWS::DynamoDB::GlobalTable resource. You should not configure additional auto scaling policies on any of the table replicas or global secondary indexes, either via API or via AWS::ApplicationAutoScaling::ScalableTarget or AWS::ApplicationAutoScaling::ScalingPolicy . Doing so might result in unexpected behavior and is unsupported.

  • In AWS CloudFormation , each global table is controlled by a single stack, in a single region, regardless of the number of replicas. When you deploy your template, CloudFormation will create/update all replicas as part of a single stack operation. You should not deploy the same AWS::DynamoDB::GlobalTable resource in multiple regions. Doing so will result in errors, and is unsupported. If you deploy your application template in multiple regions, you can use conditions to only create the resource in a single region. Alternatively, you can choose to define your AWS::DynamoDB::GlobalTable resources in a stack separate from your application stack, and make sure it is only deployed to a single region.

CloudFormation
AWS::DynamoDB::GlobalTable
Source
Generated code
Type last changed
v2.269.0 · 16 Sep 2026

Initializer ​

ts
new CfnGlobalTablePropsMixin(props: CfnGlobalTableMixinProps, options?: CfnPropertyMixinOptions)
python
CfnGlobalTablePropsMixin(props: CfnGlobalTableMixinProps, options: typing.Optional[CfnPropertyMixinOptions] = None)
java
new CfnGlobalTablePropsMixin(CfnGlobalTableMixinProps props, CfnPropertyMixinOptions options)
csharp
new CfnGlobalTablePropsMixin(CfnGlobalTableMixinProps props, CfnPropertyMixinOptions? options = null)
go
NewCfnGlobalTablePropsMixin(Props CfnGlobalTableMixinProps, Options CfnPropertyMixinOptions)

Methods ​

applyTo(construct: IConstruct): voiddef apply_to(self, construct: IConstruct) -> Nonepublic void applyTo(IConstruct construct)public void ApplyTo(IConstruct construct)func ApplyTo(Construct IConstruct)#
Apply the mixin properties to the construct.
isMixin(x: any): boolean@staticmethod def is_mixin(x: Any) -> boolpublic static Boolean isMixin(Object x)public static bool IsMixin(object x)func IsMixin(X interface{}) *boolstatic#
Checks if `x` is a Mixin.
1 parameter · returns

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Mixin.

supports(construct: IConstruct): booleandef supports(self, construct: IConstruct) -> boolpublic Boolean supports(IConstruct construct)public bool Supports(IConstruct construct)func Supports(Construct IConstruct) *bool#
Check if this mixin supports the given construct.