@aws-cdk/aws-dynamodb

constructor

constructor(scope: cdk.Construct, id: string, props: CfnGlobalTableProps);

• Create a new AWS::DynamoDB::GlobalTable.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable . The ARN returned is that of the replica in the region the stack is deployed to. Arn

property attributeDefinitions

attributeDefinitions: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions

property attrStreamArn

readonly attrStreamArn: string;

• The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 . The StreamArn returned is that of the replica in the region the stack is deployed to.

  > You must specify the StreamSpecification property to use this attribute. StreamArn

property attrTableId

readonly attrTableId: string;

• Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to. TableId

property billingMode

billingMode: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property globalSecondaryIndexes

globalSecondaryIndexes: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globalsecondaryindexes

property keySchema

keySchema: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema

property localSecondaryIndexes

localSecondaryIndexes: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes

property replicas

replicas: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas

property sseSpecification

sseSpecification: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-ssespecification

property streamSpecification

streamSpecification: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification

property tableName

tableName: string;

• 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename

property timeToLiveSpecification

timeToLiveSpecification: any;

• Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification

property writeProvisionedThroughputSettings

writeProvisionedThroughputSettings: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnTableProps);

• Create a new AWS::DynamoDB::Table.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable . Arn

property attributeDefinitions

attributeDefinitions: any;

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

  This property is required to create a DynamoDB table.

  Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) . Replacement if you edit an existing AttributeDefinition.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedefinitions

property attrStreamArn

readonly attrStreamArn: string;

• The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

  > You must specify the StreamSpecification property to use this attribute. StreamArn

property billingMode

billingMode: string;

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

  Valid values include:

  - PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual) . - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand) .

  If not specified, the default is PROVISIONED .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property contributorInsightsSpecification

contributorInsightsSpecification: any;

• The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-contributorinsightsspecification

property deletionProtectionEnabled

deletionProtectionEnabled: any;

• Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDB Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-deletionprotectionenabled

property globalSecondaryIndexes

globalSecondaryIndexes: any;

• Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.

  > If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE . You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. > > If you add or delete an index 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 index, you must manually delete the index. > > Updates are not supported. The following are exceptions: > > - If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. > - You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-globalsecondaryindexes

property importSourceSpecification

importSourceSpecification: any;

• Specifies the properties of data being imported from the S3 bucket source to the table.

  > If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification , the TableClass property, or the DeletionProtectionEnabled property, the IAM entity creating/updating stack must have UpdateTable permission.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-importsourcespecification

property keySchema

keySchema: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema

property kinesisStreamSpecification

kinesisStreamSpecification: any;

• The Kinesis Data Streams configuration for the specified table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-kinesisstreamspecification

property localSecondaryIndexes

localSecondaryIndexes: any;

• Local secondary indexes to be created on the table. You can create up to 5 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-localsecondaryindexes

property pointInTimeRecoverySpecification

pointInTimeRecoverySpecification: any;

• The settings used to enable point in time recovery.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification

property provisionedThroughput

provisionedThroughput: any;

• Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html) .

  If you set BillingMode as PROVISIONED , you must specify this property. If you set BillingMode as PAY_PER_REQUEST , you cannot specify this property.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput

property sseSpecification

sseSpecification: any;

• Specifies the settings to enable server-side encryption.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification

property streamSpecification

streamSpecification: any;

• The settings for the DynamoDB table stream, which capture changes to items stored in the table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification

property tableClass

tableClass: string;

• The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tableclass

property tableName

tableName: string;

• A name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename

property tags

readonly tags: cdk.TagManager;

• An array of key-value pairs to apply to this resource.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags

property timeToLiveSpecification

timeToLiveSpecification: any;

• Specifies the Time to Live (TTL) settings for the table.

  > For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: TableProps);

property encryptionKey

readonly encryptionKey?: kms.IKey;

property hasIndex

readonly hasIndex: boolean;

• Whether this table has indexes

property tableArn

readonly tableArn: string;

property tableName

readonly tableName: string;

property tableStreamArn

readonly tableStreamArn: string;

method addGlobalSecondaryIndex

addGlobalSecondaryIndex: (props: GlobalSecondaryIndexProps) => void;

• Add a global secondary index of table.

  Parameter props

  the property of global secondary index

method addLocalSecondaryIndex

addLocalSecondaryIndex: (props: LocalSecondaryIndexProps) => void;

• Add a local secondary index of table.

  Parameter props

  the property of local secondary index

method autoScaleGlobalSecondaryIndexReadCapacity

autoScaleGlobalSecondaryIndexReadCapacity: (
    indexName: string,
    props: EnableScalingProps
) => IScalableTableAttribute;

• Enable read capacity scaling for the given GSI

  Returns

  An object to configure additional AutoScaling settings for this attribute

method autoScaleGlobalSecondaryIndexWriteCapacity

autoScaleGlobalSecondaryIndexWriteCapacity: (
    indexName: string,
    props: EnableScalingProps
) => IScalableTableAttribute;

• Enable write capacity scaling for the given GSI

  Returns

  An object to configure additional AutoScaling settings for this attribute

method autoScaleReadCapacity

autoScaleReadCapacity: (props: EnableScalingProps) => IScalableTableAttribute;

• Enable read capacity scaling for this table

  Returns

  An object to configure additional AutoScaling settings

method autoScaleWriteCapacity

autoScaleWriteCapacity: (props: EnableScalingProps) => IScalableTableAttribute;

• Enable write capacity scaling for this table

  Returns

  An object to configure additional AutoScaling settings for this attribute

method fromTableArn

static fromTableArn: (scope: Construct, id: string, tableArn: string) => ITable;

• Creates a Table construct that represents an external table via table arn.

  Parameter scope

  The parent creating construct (usually this).

  Parameter id

  The construct's name.

  Parameter tableArn

  The table's ARN.

method fromTableAttributes

static fromTableAttributes: (
    scope: Construct,
    id: string,
    attrs: TableAttributes
) => ITable;

• Creates a Table construct that represents an external table.

  Parameter scope

  The parent creating construct (usually this).

  Parameter id

  The construct's name.

  Parameter attrs

  A TableAttributes object.

method fromTableName

static fromTableName: (
    scope: Construct,
    id: string,
    tableName: string
) => ITable;

• Creates a Table construct that represents an external table via table name.

  Parameter scope

  The parent creating construct (usually this).

  Parameter id

  The construct's name.

  Parameter tableName

  The table's name.

method grantListStreams

static grantListStreams: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM Principal to list all DynamoDB Streams.

  Parameter grantee

  The principal (no-op if undefined)

  Deprecated

  Use for more granular permission

method schema

schema: (indexName?: string) => SchemaOptions;

• Get schema attributes of table or index.

  Returns

  Schema of table or index.

method validate

protected validate: () => string[];

• Validate the table construct.

  Returns

  an array of validation error message

property name

readonly name: string;

• The name of an attribute.

property type

readonly type: AttributeType;

• The data type of an attribute.

property attributeDefinitions

readonly attributeDefinitions:
    | Array<CfnGlobalTable.AttributeDefinitionProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions

property billingMode

readonly billingMode?: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode

property globalSecondaryIndexes

readonly globalSecondaryIndexes?:
    | Array<CfnGlobalTable.GlobalSecondaryIndexProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globalsecondaryindexes

property keySchema

readonly keySchema:
    | Array<CfnGlobalTable.KeySchemaProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema

property localSecondaryIndexes

readonly localSecondaryIndexes?:
    | Array<CfnGlobalTable.LocalSecondaryIndexProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes

property replicas

readonly replicas:
    | Array<CfnGlobalTable.ReplicaSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas

property sseSpecification

readonly sseSpecification?:
    | CfnGlobalTable.SSESpecificationProperty
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-ssespecification

property streamSpecification

readonly streamSpecification?:
    | CfnGlobalTable.StreamSpecificationProperty
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification

property tableName

readonly tableName?: string;

• 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename

property timeToLiveSpecification

readonly timeToLiveSpecification?:
    | CfnGlobalTable.TimeToLiveSpecificationProperty
    | cdk.IResolvable;

• Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification

property writeProvisionedThroughputSettings

readonly writeProvisionedThroughputSettings?:
    | CfnGlobalTable.WriteProvisionedThroughputSettingsProperty
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings

property attributeDefinitions

readonly attributeDefinitions?:
    | Array<CfnTable.AttributeDefinitionProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  This property is required to create a DynamoDB table.

  Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) . Replacement if you edit an existing AttributeDefinition.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedefinitions

property billingMode

readonly billingMode?: string;

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

  Valid values include:

  - PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual) . - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand) .

  If not specified, the default is PROVISIONED .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode

property contributorInsightsSpecification

readonly contributorInsightsSpecification?:
    | CfnTable.ContributorInsightsSpecificationProperty
    | cdk.IResolvable;

• The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-contributorinsightsspecification

property deletionProtectionEnabled

readonly deletionProtectionEnabled?: boolean | cdk.IResolvable;

• Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDB Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-deletionprotectionenabled

property globalSecondaryIndexes

readonly globalSecondaryIndexes?:
    | Array<CfnTable.GlobalSecondaryIndexProperty | cdk.IResolvable>
    | cdk.IResolvable;

• Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.

  > If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE . You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. > > If you add or delete an index 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 index, you must manually delete the index. > > Updates are not supported. The following are exceptions: > > - If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. > - You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-globalsecondaryindexes

property importSourceSpecification

readonly importSourceSpecification?:
    | CfnTable.ImportSourceSpecificationProperty
    | cdk.IResolvable;

• Specifies the properties of data being imported from the S3 bucket source to the table.

  > If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification , the TableClass property, or the DeletionProtectionEnabled property, the IAM entity creating/updating stack must have UpdateTable permission.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-importsourcespecification

property keySchema

readonly keySchema:
    | Array<CfnTable.KeySchemaProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema

property kinesisStreamSpecification

readonly kinesisStreamSpecification?:
    | CfnTable.KinesisStreamSpecificationProperty
    | cdk.IResolvable;

• The Kinesis Data Streams configuration for the specified table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-kinesisstreamspecification

property localSecondaryIndexes

readonly localSecondaryIndexes?:
    | Array<CfnTable.LocalSecondaryIndexProperty | cdk.IResolvable>
    | cdk.IResolvable;

• Local secondary indexes to be created on the table. You can create up to 5 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-localsecondaryindexes

property pointInTimeRecoverySpecification

readonly pointInTimeRecoverySpecification?:
    | CfnTable.PointInTimeRecoverySpecificationProperty
    | cdk.IResolvable;

• The settings used to enable point in time recovery.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification

property provisionedThroughput

readonly provisionedThroughput?:
    | CfnTable.ProvisionedThroughputProperty
    | cdk.IResolvable;

• Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html) .

  If you set BillingMode as PROVISIONED , you must specify this property. If you set BillingMode as PAY_PER_REQUEST , you cannot specify this property.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput

property sseSpecification

readonly sseSpecification?: CfnTable.SSESpecificationProperty | cdk.IResolvable;

• Specifies the settings to enable server-side encryption.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification

property streamSpecification

readonly streamSpecification?:
    | CfnTable.StreamSpecificationProperty
    | cdk.IResolvable;

• The settings for the DynamoDB table stream, which capture changes to items stored in the table.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification

property tableClass

readonly tableClass?: string;

• The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tableclass

property tableName

readonly tableName?: string;

• A name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename

property tags

readonly tags?: cdk.CfnTag[];

• An array of key-value pairs to apply to this resource.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags

property timeToLiveSpecification

readonly timeToLiveSpecification?:
    | CfnTable.TimeToLiveSpecificationProperty
    | cdk.IResolvable;

• Specifies the Time to Live (TTL) settings for the table.

  > For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification

property maxCapacity

readonly maxCapacity: number;

• Maximum capacity to scale to

property minCapacity

readonly minCapacity: number;

• Minimum capacity to scale to

property readCapacity

readonly readCapacity?: number;

• The read capacity for the global secondary index.

  Can only be provided if table billingMode is Provisioned or undefined.

  5

property writeCapacity

readonly writeCapacity?: number;

• The write capacity for the global secondary index.

  Can only be provided if table billingMode is Provisioned or undefined.

  5

method scaleOnSchedule

scaleOnSchedule: (id: string, actions: appscaling.ScalingSchedule) => void;

• Add scheduled scaling for this scaling attribute

method scaleOnUtilization

scaleOnUtilization: (props: UtilizationScalingProps) => void;

• Scale out or in to keep utilization at a given level

property encryptionKey

readonly encryptionKey?: kms.IKey;

• Optional KMS encryption key associated with this table.

property tableArn

readonly tableArn: string;

• Arn of the dynamodb table.

property tableName

readonly tableName: string;

• Table name of the dynamodb table.

property tableStreamArn

readonly tableStreamArn?: string;

• ARN of the table's stream, if there is one.

method grant

grant: (grantee: iam.IGrantable, ...actions: string[]) => iam.Grant;

• Adds an IAM policy statement associated with this table to an IAM principal's policy.

  If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

  Parameter grantee

  The principal (no-op if undefined)

  Parameter actions

  The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...)

method grantFullAccess

grantFullAccess: (grantee: iam.IGrantable) => iam.Grant;

• Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.

  Appropriate grants will also be added to the customer-managed KMS key if one was configured.

  Parameter grantee

  The principal to grant access to

method grantReadData

grantReadData: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.

  Appropriate grants will also be added to the customer-managed KMS key if one was configured.

  Parameter grantee

  The principal to grant access to

method grantReadWriteData

grantReadWriteData: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM principal to all data read/write operations to this table. BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem, DeleteItem

  Appropriate grants will also be added to the customer-managed KMS key if one was configured.

  Parameter grantee

  The principal to grant access to

method grantStream

grantStream: (grantee: iam.IGrantable, ...actions: string[]) => iam.Grant;

• Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.

  If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

  Parameter grantee

  The principal (no-op if undefined)

  Parameter actions

  The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...)

method grantStreamRead

grantStreamRead: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.

  Appropriate grants will also be added to the customer-managed KMS key if one was configured.

  Parameter grantee

  The principal to grant access to

method grantTableListStreams

grantTableListStreams: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM Principal to list streams attached to current dynamodb table.

  Parameter grantee

  The principal (no-op if undefined)

method grantWriteData

grantWriteData: (grantee: iam.IGrantable) => iam.Grant;

• Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.

  Appropriate grants will also be added to the customer-managed KMS key if one was configured.

  Parameter grantee

  The principal to grant access to

method metric

metric: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Metric for the number of Errors executing all Lambdas

method metricConditionalCheckFailedRequests

metricConditionalCheckFailedRequests: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Metric for the conditional check failed requests

  Parameter props

  properties of a metric

method metricConsumedReadCapacityUnits

metricConsumedReadCapacityUnits: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Metric for the consumed read capacity units

  Parameter props

  properties of a metric

method metricConsumedWriteCapacityUnits

metricConsumedWriteCapacityUnits: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Metric for the consumed write capacity units

  Parameter props

  properties of a metric

method metricSuccessfulRequestLatency

metricSuccessfulRequestLatency: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Metric for the successful request latency

  Parameter props

  properties of a metric

method metricSystemErrors

metricSystemErrors: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• Metric for the system errors

  Parameter props

  properties of a metric

  Deprecated

  use metricSystemErrorsForOperations

method metricSystemErrorsForOperations

metricSystemErrorsForOperations: (
    props?: SystemErrorsForOperationsMetricOptions
) => cloudwatch.IMetric;

• Metric for the system errors this table

  Parameter props

  properties of a metric

method metricThrottledRequests

metricThrottledRequests: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• Metric for throttled requests

  Parameter props

  properties of a metric

method metricUserErrors

metricUserErrors: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• Metric for the user errors

  Parameter props

  properties of a metric

property sortKey

readonly sortKey: Attribute;

• The attribute of a sort key for the local secondary index.

property partitionKey

readonly partitionKey: Attribute;

• Partition key attribute definition.

property sortKey

readonly sortKey?: Attribute;

• Sort key attribute definition.

  no sort key

property indexName

readonly indexName: string;

• The name of the secondary index.

property nonKeyAttributes

readonly nonKeyAttributes?: string[];

• The non-key attributes that are projected into the secondary index. - No additional attributes

property projectionType

readonly projectionType?: ProjectionType;

• The set of attributes that are projected into the secondary index. ALL

property operations

readonly operations?: Operation[];

• The operations to apply the metric to.

  - All operations available by DynamoDB tables will be considered.

property encryptionKey

readonly encryptionKey?: kms.IKey;

• KMS encryption key, if this table uses a customer-managed encryption key.

  - no key

property globalIndexes

readonly globalIndexes?: string[];

• The name of the global indexes set for this Table. Note that you need to set either this property, or localIndexes, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

  - no global indexes

property localIndexes

readonly localIndexes?: string[];

• The name of the local indexes set for this Table. Note that you need to set either this property, or globalIndexes, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

  - no local indexes

property tableArn

readonly tableArn?: string;

• The ARN of the dynamodb table. One of this, or tableName, is required.

  - no table arn

property tableName

readonly tableName?: string;

• The table name of the dynamodb table. One of this, or tableArn, is required.

  - no table name

property tableStreamArn

readonly tableStreamArn?: string;

• The ARN of the table's stream.

  - no table stream

property billingMode

readonly billingMode?: BillingMode;

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

  PROVISIONED if replicationRegions is not specified, PAY_PER_REQUEST otherwise

property contributorInsightsEnabled

readonly contributorInsightsEnabled?: boolean;

• Whether CloudWatch contributor insights is enabled.

  false

property encryption

readonly encryption?: TableEncryption;

• Whether server-side encryption with an AWS managed customer master key is enabled.

  This property cannot be set if serverSideEncryption is set.

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

  - server-side encryption is enabled with an AWS owned customer master key

property encryptionKey

readonly encryptionKey?: kms.IKey;

• External KMS key to use for table encryption.

  This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

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

property pointInTimeRecovery

readonly pointInTimeRecovery?: boolean;

• Whether point-in-time recovery is enabled. - point-in-time recovery is disabled

property readCapacity

readonly readCapacity?: number;

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

  5

property removalPolicy

readonly removalPolicy?: RemovalPolicy;

• The removal policy to apply to the DynamoDB Table.

  RemovalPolicy.RETAIN

property replicationRegions

readonly replicationRegions?: string[];

• Regions where replica tables will be created

  - no replica tables are created

property replicationTimeout

readonly replicationTimeout?: Duration;

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

  Duration.minutes(30)

property serverSideEncryption

readonly serverSideEncryption?: boolean;

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

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

property stream

readonly stream?: StreamViewType;

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

  - streams are disabled unless replicationRegions is specified

property tableClass

readonly tableClass?: TableClass;

• Specify the table class. STANDARD

property timeToLiveAttribute

readonly timeToLiveAttribute?: string;

• The name of TTL attribute. - TTL is disabled

property waitForReplicationToFinish

readonly waitForReplicationToFinish?: boolean;

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

  See Also

  • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas true

property writeCapacity

readonly writeCapacity?: number;

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

  5

property kinesisStream

readonly kinesisStream?: kinesis.IStream;

• Kinesis Data Stream to capture item-level changes for the table.

  - no Kinesis Data Stream

property tableName

readonly tableName?: string;

• Enforces a particular physical table name.

property targetUtilizationPercent

readonly targetUtilizationPercent: number;

• Target utilization percentage for the attribute

member BINARY

BINARY = 'B'

• Up to 400KiB of binary data (which must be encoded as base64 before sending to DynamoDB)

member NUMBER

NUMBER = 'N'

• Numeric values made of up to 38 digits (positive, negative or zero)

member STRING

STRING = 'S'

• Up to 400KiB of UTF-8 encoded text

member PAY_PER_REQUEST

PAY_PER_REQUEST = 'PAY_PER_REQUEST'

• Pay only for what you use. You don't configure Read/Write capacity units.

member PROVISIONED

PROVISIONED = 'PROVISIONED'

• Explicitly specified Read/Write capacity units.

member BATCH_EXECUTE_STATEMENT

BATCH_EXECUTE_STATEMENT = 'BatchExecuteStatement'

• BatchExecuteStatement

member BATCH_GET_ITEM

BATCH_GET_ITEM = 'BatchGetItem'

• BatchGetItem

member BATCH_WRITE_ITEM

BATCH_WRITE_ITEM = 'BatchWriteItem'

• BatchWriteItem

member DELETE_ITEM

DELETE_ITEM = 'DeleteItem'

• DeleteItem

member EXECUTE_STATEMENT

EXECUTE_STATEMENT = 'ExecuteStatement'

• ExecuteStatement

member EXECUTE_TRANSACTION

EXECUTE_TRANSACTION = 'ExecuteTransaction'

• ExecuteTransaction

member GET_ITEM

GET_ITEM = 'GetItem'

• GetItem

member GET_RECORDS

GET_RECORDS = 'GetRecords'

• GetRecords

member PUT_ITEM

PUT_ITEM = 'PutItem'

• PutItem

member QUERY

QUERY = 'Query'

• Query

member SCAN

SCAN = 'Scan'

• Scan

member TRANSACT_GET_ITEMS

TRANSACT_GET_ITEMS = 'TransactGetItems'

• TransactGetItems

member TRANSACT_WRITE_ITEMS

TRANSACT_WRITE_ITEMS = 'TransactWriteItems'

• TransactWriteItems

member UPDATE_ITEM

UPDATE_ITEM = 'UpdateItem'

• UpdateItem

member ALL

ALL = 'ALL'

• All of the table attributes are projected into the index.

member INCLUDE

INCLUDE = 'INCLUDE'

• Only the specified table attributes are projected into the index. The list of projected attributes is in nonKeyAttributes.

member KEYS_ONLY

KEYS_ONLY = 'KEYS_ONLY'

• Only the index and primary keys are projected into the index.

member KEYS_ONLY

KEYS_ONLY = 'KEYS_ONLY'

• Only the key attributes of the modified item are written to the stream.

member NEW_AND_OLD_IMAGES

NEW_AND_OLD_IMAGES = 'NEW_AND_OLD_IMAGES'

• Both the new and the old item images of the item are written to the stream.

member NEW_IMAGE

NEW_IMAGE = 'NEW_IMAGE'

• The entire item, as it appears after it was modified, is written to the stream.

member OLD_IMAGE

OLD_IMAGE = 'OLD_IMAGE'

• The entire item, as it appeared before it was modified, is written to the stream.

member STANDARD

STANDARD = 'STANDARD'

• Default table class for DynamoDB.

member STANDARD_INFREQUENT_ACCESS

STANDARD_INFREQUENT_ACCESS = 'STANDARD_INFREQUENT_ACCESS'

• Table class for DynamoDB that reduces storage costs compared to existing DynamoDB Standard tables.

member AWS_MANAGED

AWS_MANAGED = 'AWS_MANAGED'

• Server-side KMS encryption with a master key managed by AWS.

member CUSTOMER_MANAGED

CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'

• Server-side KMS encryption with a customer master key managed by customer. If encryptionKey is specified, this key will be used, otherwise, one will be defined.

  > **NOTE**: if encryptionKey is not specified and the Table construct creates > a KMS key for you, the key 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.

member DEFAULT

DEFAULT = 'AWS_OWNED'

• Server-side KMS encryption with a master key owned by AWS.