interface CfnGlobalTableProps

Language	Type name
.NET	`Amazon.CDK.AWS.DynamoDB.CfnGlobalTableProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTableProps`
Java	`software.amazon.awscdk.services.dynamodb.CfnGlobalTableProps`
Python	`aws_cdk.aws_dynamodb.CfnGlobalTableProps`
TypeScript	`aws-cdk-lib` » `aws_dynamodb` » `CfnGlobalTableProps`

Properties for defining a CfnGlobalTable.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';

declare const policyDocument: any;
const cfnGlobalTableProps: dynamodb.CfnGlobalTableProps = {
  attributeDefinitions: [{
    attributeName: 'attributeName',
    attributeType: 'attributeType',
  }],
  keySchema: [{
    attributeName: 'attributeName',
    keyType: 'keyType',
  }],
  replicas: [{
    region: 'region',

    // the properties below are optional
    contributorInsightsSpecification: {
      enabled: false,
    },
    deletionProtectionEnabled: false,
    globalSecondaryIndexes: [{
      indexName: 'indexName',

      // the properties below are optional
      contributorInsightsSpecification: {
        enabled: false,
      },
      readOnDemandThroughputSettings: {
        maxReadRequestUnits: 123,
      },
      readProvisionedThroughputSettings: {
        readCapacityAutoScalingSettings: {
          maxCapacity: 123,
          minCapacity: 123,
          targetTrackingScalingPolicyConfiguration: {
            targetValue: 123,

            // the properties below are optional
            disableScaleIn: false,
            scaleInCooldown: 123,
            scaleOutCooldown: 123,
          },

          // the properties below are optional
          seedCapacity: 123,
        },
        readCapacityUnits: 123,
      },
    }],
    kinesisStreamSpecification: {
      streamArn: 'streamArn',

      // the properties below are optional
      approximateCreationDateTimePrecision: 'approximateCreationDateTimePrecision',
    },
    pointInTimeRecoverySpecification: {
      pointInTimeRecoveryEnabled: false,
    },
    readOnDemandThroughputSettings: {
      maxReadRequestUnits: 123,
    },
    readProvisionedThroughputSettings: {
      readCapacityAutoScalingSettings: {
        maxCapacity: 123,
        minCapacity: 123,
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },

        // the properties below are optional
        seedCapacity: 123,
      },
      readCapacityUnits: 123,
    },
    replicaStreamSpecification: {
      resourcePolicy: {
        policyDocument: policyDocument,
      },
    },
    resourcePolicy: {
      policyDocument: policyDocument,
    },
    sseSpecification: {
      kmsMasterKeyId: 'kmsMasterKeyId',
    },
    tableClass: 'tableClass',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],

  // the properties below are optional
  billingMode: 'billingMode',
  globalSecondaryIndexes: [{
    indexName: 'indexName',
    keySchema: [{
      attributeName: 'attributeName',
      keyType: 'keyType',
    }],
    projection: {
      nonKeyAttributes: ['nonKeyAttributes'],
      projectionType: 'projectionType',
    },

    // the properties below are optional
    warmThroughput: {
      readUnitsPerSecond: 123,
      writeUnitsPerSecond: 123,
    },
    writeOnDemandThroughputSettings: {
      maxWriteRequestUnits: 123,
    },
    writeProvisionedThroughputSettings: {
      writeCapacityAutoScalingSettings: {
        maxCapacity: 123,
        minCapacity: 123,
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },

        // the properties below are optional
        seedCapacity: 123,
      },
    },
  }],
  localSecondaryIndexes: [{
    indexName: 'indexName',
    keySchema: [{
      attributeName: 'attributeName',
      keyType: 'keyType',
    }],
    projection: {
      nonKeyAttributes: ['nonKeyAttributes'],
      projectionType: 'projectionType',
    },
  }],
  sseSpecification: {
    sseEnabled: false,

    // the properties below are optional
    sseType: 'sseType',
  },
  streamSpecification: {
    streamViewType: 'streamViewType',
  },
  tableName: 'tableName',
  timeToLiveSpecification: {
    enabled: false,

    // the properties below are optional
    attributeName: 'attributeName',
  },
  warmThroughput: {
    readUnitsPerSecond: 123,
    writeUnitsPerSecond: 123,
  },
  writeOnDemandThroughputSettings: {
    maxWriteRequestUnits: 123,
  },
  writeProvisionedThroughputSettings: {
    writeCapacityAutoScalingSettings: {
      maxCapacity: 123,
      minCapacity: 123,
      targetTrackingScalingPolicyConfiguration: {
        targetValue: 123,

        // the properties below are optional
        disableScaleIn: false,
        scaleInCooldown: 123,
        scaleOutCooldown: 123,
      },

      // the properties below are optional
      seedCapacity: 123,
    },
  },
};

Properties

Name	Type	Description
attributeDefinitions	`IResolvable` `\|` `IResolvable` `\|` `AttributeDefinitionProperty[]`	A list of attributes that describe the key schema for the global table and indexes.
keySchema	`IResolvable` `\|` `IResolvable` `\|` `KeySchemaProperty[]`	Specifies the attributes that make up the primary key for the table.
replicas	`IResolvable` `\|` `IResolvable` `\|` `ReplicaSpecificationProperty[]`	Specifies the list of replicas for your global table.
billingMode?	`string`	Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.
globalSecondaryIndexes?	`IResolvable` `\|` `IResolvable` `\|` `GlobalSecondaryIndexProperty[]`	Global secondary indexes to be created on the global table.
localSecondaryIndexes?	`IResolvable` `\|` `IResolvable` `\|` `LocalSecondaryIndexProperty[]`	Local secondary indexes to be created on the table.
sseSpecification?	`IResolvable` `\|` `SSESpecificationProperty`	Specifies the settings to enable server-side encryption.
streamSpecification?	`IResolvable` `\|` `StreamSpecificationProperty`	Specifies the streams settings on your global table.
tableName?	`string`	A name for the global table.
timeToLiveSpecification?	`IResolvable` `\|` `TimeToLiveSpecificationProperty`	Specifies the time to live (TTL) settings for the table.
warmThroughput?	`IResolvable` `\|` `WarmThroughputProperty`	Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.
writeOnDemandThroughputSettings?	`IResolvable` `\|` `WriteOnDemandThroughputSettingsProperty`	Sets the write request settings for a global table or a global secondary index.
writeProvisionedThroughputSettings?	`IResolvable` `\|` `WriteProvisionedThroughputSettingsProperty`	Specifies an auto scaling policy for write capacity.

attributeDefinitions

Type: IResolvable | IResolvable | AttributeDefinitionProperty[]

A list of attributes that describe the key schema for the global table and indexes.

keySchema

Type: IResolvable | IResolvable | KeySchemaProperty[]

Specifies the attributes that make up the primary key for the table.

The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

replicas

Type: IResolvable | IResolvable | ReplicaSpecificationProperty[]

Specifies the list of replicas for your global table.

The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in Replicas with the region us-east-1. You cannot remove the replica in the stack region.

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.

If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

billingMode?

Type: string (optional)

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.

PAY_PER_REQUEST
PROVISIONED

All replicas in your global table will have the same billing mode. If you use PROVISIONED billing mode, you must provide an auto scaling configuration via the WriteProvisionedThroughputSettings property. The default value of this property is PROVISIONED .

globalSecondaryIndexes?

Type: IResolvable | IResolvable | GlobalSecondaryIndexProperty[] (optional)

Global secondary indexes to be created on the global table.

You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.

Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.

localSecondaryIndexes?

Type: IResolvable | IResolvable | LocalSecondaryIndexProperty[] (optional)

Local secondary indexes to be created on the table.

You can create up to five local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. Each replica in your global table will have the same local secondary index settings.

sseSpecification?

Type: IResolvable | SSESpecificationProperty (optional)

Specifies the settings to enable server-side encryption.

These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the ReplicaSpecification.ReplicaSSESpecification property.

streamSpecification?

Type: IResolvable | StreamSpecificationProperty (optional)

Specifies the streams settings on your global table.

You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.

tableName?

Type: string (optional)

A name for the global table.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

timeToLiveSpecification?

Type: IResolvable | TimeToLiveSpecificationProperty (optional)

Specifies the time to live (TTL) settings for the table.

This setting will be applied to all replicas.

warmThroughput?

Type: IResolvable | WarmThroughputProperty (optional)

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.

writeOnDemandThroughputSettings?

Type: IResolvable | WriteOnDemandThroughputSettingsProperty (optional)

Sets the write request settings for a global table or a global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

writeProvisionedThroughputSettings?

Type: IResolvable | WriteProvisionedThroughputSettingsProperty (optional)

Specifies an auto scaling policy for write capacity.

This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .