aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
789 lines • 120 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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](https://docs.aws.amazon.com//amazondynamodb/latest/developerguide/GlobalTables.html) .
*
* > 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.
*
* - `dynamodb:CreateTable`
* - `dynamodb:UpdateTable`
* - `dynamodb:DeleteTable`
* - `dynamodb:DescribeContinuousBackups`
* - `dynamodb:DescribeContributorInsights`
* - `dynamodb:DescribeTable`
* - `dynamodb:DescribeTableReplicaAutoScaling`
* - `dynamodb:DescribeTimeToLive`
* - `dynamodb:ListTables`
* - `dynamodb:UpdateTimeToLive`
* - `dynamodb:UpdateContributorInsights`
* - `dynamodb:UpdateContinuousBackups`
* - `dynamodb:ListTagsOfResource`
* - `dynamodb:TagResource`
* - `dynamodb:UntagResource`
* - `dynamodb:BatchWriteItem`
* - `dynamodb:CreateTableReplica`
* - `dynamodb:DeleteItem`
* - `dynamodb:DeleteTableReplica`
* - `dynamodb:DisableKinesisStreamingDestination`
* - `dynamodb:EnableKinesisStreamingDestination`
* - `dynamodb:GetItem`
* - `dynamodb:PutItem`
* - `dynamodb:Query`
* - `dynamodb:Scan`
* - `dynamodb:UpdateItem`
* - `dynamodb:DescribeTableReplicaAutoScaling`
* - `dynamodb:UpdateTableReplicaAutoScaling`
* - `iam:CreateServiceLinkedRole`
* - `kms:CreateGrant`
* - `kms:DescribeKey`
* - `application-autoscaling:DeleteScalingPolicy`
* - `application-autoscaling:DeleteScheduledAction`
* - `application-autoscaling:DeregisterScalableTarget`
* - `application-autoscaling:DescribeScalingPolicies`
* - `application-autoscaling:DescribeScalableTargets`
* - `application-autoscaling:PutScalingPolicy`
* - `application-autoscaling:PutScheduledAction`
* - `application-autoscaling:RegisterScalableTarget`
* - 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.
*
* @cloudformationResource AWS::DynamoDB::GlobalTable
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html
*/
export declare class CfnGlobalTable extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnGlobalTable from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGlobalTable;
/**
* 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.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: 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.
*
* @cloudformationAttribute StreamArn
*/
readonly attrStreamArn: 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.
*
* @cloudformationAttribute TableId
*/
readonly attrTableId: string;
/**
* A list of attributes that describe the key schema for the global table and indexes.
*/
attributeDefinitions: Array<CfnGlobalTable.AttributeDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.
*/
billingMode?: string;
/**
* Global secondary indexes to be created on the global table.
*/
globalSecondaryIndexes?: Array<CfnGlobalTable.GlobalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Specifies the attributes that make up the primary key for the table.
*/
keySchema: Array<cdk.IResolvable | CfnGlobalTable.KeySchemaProperty> | cdk.IResolvable;
/**
* Local secondary indexes to be created on the table.
*/
localSecondaryIndexes?: Array<cdk.IResolvable | CfnGlobalTable.LocalSecondaryIndexProperty> | cdk.IResolvable;
/**
* Specifies the list of replicas for your global table.
*/
replicas: Array<cdk.IResolvable | CfnGlobalTable.ReplicaSpecificationProperty> | cdk.IResolvable;
/**
* Specifies the settings to enable server-side encryption.
*/
sseSpecification?: cdk.IResolvable | CfnGlobalTable.SSESpecificationProperty;
/**
* Specifies the streams settings on your global table.
*/
streamSpecification?: cdk.IResolvable | CfnGlobalTable.StreamSpecificationProperty;
/**
* A name for the global table.
*/
tableName?: string;
/**
* Specifies the time to live (TTL) settings for the table.
*/
timeToLiveSpecification?: cdk.IResolvable | CfnGlobalTable.TimeToLiveSpecificationProperty;
/**
* Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.
*/
warmThroughput?: cdk.IResolvable | CfnGlobalTable.WarmThroughputProperty;
/**
* Sets the write request settings for a global table or a global secondary index.
*/
writeOnDemandThroughputSettings?: cdk.IResolvable | CfnGlobalTable.WriteOnDemandThroughputSettingsProperty;
/**
* Specifies an auto scaling policy for write capacity.
*/
writeProvisionedThroughputSettings?: cdk.IResolvable | CfnGlobalTable.WriteProvisionedThroughputSettingsProperty;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnGlobalTableProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnGlobalTable {
/**
* Represents the settings used to enable server-side encryption.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html
*/
interface SSESpecificationProperty {
/**
* Indicates whether server-side encryption is performed using an AWS managed key or an AWS owned key.
*
* If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object. You cannot mix AWS managed and customer managed KMS keys.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-sseenabled
*/
readonly sseEnabled: boolean | cdk.IResolvable;
/**
* Server-side encryption type. The only supported value is:.
*
* - `KMS` - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-ssetype
*/
readonly sseType?: string;
}
/**
* Represents an attribute for describing the schema for the table and indexes.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html
*/
interface AttributeDefinitionProperty {
/**
* A name for the attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributename
*/
readonly attributeName: string;
/**
* The data type for the attribute, where:.
*
* - `S` - the attribute is of type String
* - `N` - the attribute is of type Number
* - `B` - the attribute is of type Binary
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributetype
*/
readonly attributeType: string;
}
/**
* Represents the DynamoDB Streams configuration for a table in DynamoDB.
*
* You can only modify this value if your `AWS::DynamoDB::GlobalTable` contains only one entry in `Replicas` . You must specify a value for this property if your `AWS::DynamoDB::GlobalTable` contains more than one replica.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html
*/
interface StreamSpecificationProperty {
/**
* When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table.
*
* Valid values for `StreamViewType` are:
*
* - `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
* - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
* - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
* - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html#cfn-dynamodb-globaltable-streamspecification-streamviewtype
*/
readonly streamViewType: string;
}
/**
* Allows you to specify a global secondary index for the global table.
*
* The index will be defined on all replicas.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html
*/
interface GlobalSecondaryIndexProperty {
/**
* The name of the global secondary index.
*
* The name must be unique among all other indexes on this table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-indexname
*/
readonly indexName: string;
/**
* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - `HASH` - partition key - `RANGE` - sort key > The partition key of an item is also known as its *hash attribute* .
*
* The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
* >
* > The sort key of an item is also known as its *range attribute* . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema
*/
readonly keySchema: Array<cdk.IResolvable | CfnGlobalTable.KeySchemaProperty> | cdk.IResolvable;
/**
* Represents attributes that are copied (projected) from the table into the global secondary index.
*
* These are in addition to the primary key attributes and index key attributes, which are automatically projected.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-projection
*/
readonly projection: cdk.IResolvable | CfnGlobalTable.ProjectionProperty;
/**
* Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
*
* If you use this parameter, you must specify `ReadUnitsPerSecond` , `WriteUnitsPerSecond` , or both.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput
*/
readonly warmThroughput?: cdk.IResolvable | CfnGlobalTable.WarmThroughputProperty;
/**
* 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` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings
*/
readonly writeOnDemandThroughputSettings?: cdk.IResolvable | CfnGlobalTable.WriteOnDemandThroughputSettingsProperty;
/**
* Defines write capacity settings for the global secondary index.
*
* You must specify a value for this property if the table's `BillingMode` is `PROVISIONED` . All replicas will have the same write capacity settings for this global secondary index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings
*/
readonly writeProvisionedThroughputSettings?: cdk.IResolvable | CfnGlobalTable.WriteProvisionedThroughputSettingsProperty;
}
/**
* Represents attributes that are copied (projected) from the table into an index.
*
* These are in addition to the primary key attributes and index key attributes, which are automatically projected.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html
*/
interface ProjectionProperty {
/**
* Represents the non-key attribute names which will be projected into the index.
*
* For local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-nonkeyattributes
*/
readonly nonKeyAttributes?: Array<string>;
/**
* The set of attributes that are projected into the index:.
*
* - `KEYS_ONLY` - Only the index and primary keys are projected into the index.
* - `INCLUDE` - In addition to the attributes described in `KEYS_ONLY` , the secondary index will include other non-key attributes that you specify.
* - `ALL` - All of the table attributes are projected into the index.
*
* When using the DynamoDB console, `ALL` is selected by default.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-projectiontype
*/
readonly projectionType?: string;
}
/**
* Represents *a single element* of a key schema.
*
* A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
*
* A `KeySchemaElement` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one `KeySchemaElement` (for the partition key). A composite primary key would require one `KeySchemaElement` for the partition key, and another `KeySchemaElement` for the sort key.
*
* A `KeySchemaElement` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html
*/
interface KeySchemaProperty {
/**
* The name of a key attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-attributename
*/
readonly attributeName: string;
/**
* The role that this key attribute will assume:.
*
* - `HASH` - partition key
* - `RANGE` - sort key
*
* > The partition key of an item is also known as its *hash attribute* . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
* >
* > The sort key of an item is also known as its *range attribute* . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-keytype
*/
readonly keyType: string;
}
/**
* 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` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html
*/
interface WriteProvisionedThroughputSettingsProperty {
/**
* Specifies auto scaling settings for the replica table or global secondary index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings
*/
readonly writeCapacityAutoScalingSettings?: CfnGlobalTable.CapacityAutoScalingSettingsProperty | cdk.IResolvable;
}
/**
* Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html
*/
interface CapacityAutoScalingSettingsProperty {
/**
* The maximum provisioned capacity units for the global table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity
*/
readonly maxCapacity: number;
/**
* The minimum provisioned capacity units for the global table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity
*/
readonly minCapacity: number;
/**
* When switching billing mode from `PAY_PER_REQUEST` to `PROVISIONED` , DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index.
*
* These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.
*
* If you want to switch a table's billing mode from `PAY_PER_REQUEST` to `PROVISIONED` , you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either the `SeedCapacity` or `ReadCapacityUnits` properties. For example, if your global secondary index `myGSI` has a `SeedCapacity` of 10 in us-east-1 and a fixed `ReadCapacityUnits` of 20 in eu-west-1, CloudFormation will initially set the read capacity for `myGSI` to 20. Note that if you disable `ScaleIn` for `myGSI` in us-east-1, its read capacity units might not be set back to 10.
*
* You must also specify a value for `SeedCapacity` when you plan to switch a table's billing mode from `PROVISIONED` to `PAY_PER_REQUEST` , because CloudFormation might need to roll back the operation (reverting the billing mode to `PROVISIONED` ) and this cannot succeed without specifying a value for `SeedCapacity` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity
*/
readonly seedCapacity?: number;
/**
* Defines a target tracking scaling policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration
*/
readonly targetTrackingScalingPolicyConfiguration: cdk.IResolvable | CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty;
}
/**
* Defines a target tracking scaling policy.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html
*/
interface TargetTrackingScalingPolicyConfigurationProperty {
/**
* Indicates whether scale in by the target tracking scaling policy is disabled.
*
* The default value is `false` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein
*/
readonly disableScaleIn?: boolean | cdk.IResolvable;
/**
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown
*/
readonly scaleInCooldown?: number;
/**
* The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown
*/
readonly scaleOutCooldown?: number;
/**
* Defines a target value for the scaling policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue
*/
readonly targetValue: number;
}
/**
* 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` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html
*/
interface WriteOnDemandThroughputSettingsProperty {
/**
* Maximum number of write request settings for the specified replica of a global table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html#cfn-dynamodb-globaltable-writeondemandthroughputsettings-maxwriterequestunits
*/
readonly maxWriteRequestUnits?: number;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html
*/
interface WarmThroughputProperty {
/**
* Represents the number of read operations your base table can instantaneously support.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html#cfn-dynamodb-globaltable-warmthroughput-readunitspersecond
*/
readonly readUnitsPerSecond?: number;
/**
* Represents the number of write operations your base table can instantaneously support.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html#cfn-dynamodb-globaltable-warmthroughput-writeunitspersecond
*/
readonly writeUnitsPerSecond?: number;
}
/**
* Represents the properties of a local secondary index.
*
* A local secondary index can only be created when its parent table is created.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html
*/
interface LocalSecondaryIndexProperty {
/**
* The name of the local secondary index.
*
* The name must be unique among all other indexes on this table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-indexname
*/
readonly indexName: string;
/**
* The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - `HASH` - partition key - `RANGE` - sort key > The partition key of an item is also known as its *hash attribute* .
*
* The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
* >
* > The sort key of an item is also known as its *range attribute* . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-keyschema
*/
readonly keySchema: Array<cdk.IResolvable | CfnGlobalTable.KeySchemaProperty> | cdk.IResolvable;
/**
* Represents attributes that are copied (projected) from the table into the local secondary index.
*
* These are in addition to the primary key attributes and index key attributes, which are automatically projected.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-projection
*/
readonly projection: cdk.IResolvable | CfnGlobalTable.ProjectionProperty;
}
/**
* Defines settings specific to a single replica of a global table.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html
*/
interface ReplicaSpecificationProperty {
/**
* The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.
*
* When not specified, defaults to contributor insights disabled for the replica.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification
*/
readonly contributorInsightsSpecification?: CfnGlobalTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
/**
* Determines if a replica 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* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled
*/
readonly deletionProtectionEnabled?: boolean | cdk.IResolvable;
/**
* Defines additional settings for the global secondary indexes of this replica.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes
*/
readonly globalSecondaryIndexes?: Array<cdk.IResolvable | CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty> | cdk.IResolvable;
/**
* Defines the Kinesis Data Streams configuration for the specified replica.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification
*/
readonly kinesisStreamSpecification?: cdk.IResolvable | CfnGlobalTable.KinesisStreamSpecificationProperty;
/**
* The settings used to enable point in time recovery.
*
* When not specified, defaults to point in time recovery disabled for the replica.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification
*/
readonly pointInTimeRecoverySpecification?: cdk.IResolvable | CfnGlobalTable.PointInTimeRecoverySpecificationProperty;
/**
* Sets read request settings for the replica table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings
*/
readonly readOnDemandThroughputSettings?: cdk.IResolvable | CfnGlobalTable.ReadOnDemandThroughputSettingsProperty;
/**
* Defines read capacity settings for the replica table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings
*/
readonly readProvisionedThroughputSettings?: cdk.IResolvable | CfnGlobalTable.ReadProvisionedThroughputSettingsProperty;
/**
* The region in which this replica exists.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-region
*/
readonly region: string;
/**
* Represents the DynamoDB Streams configuration for a global table replica.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification
*/
readonly replicaStreamSpecification?: cdk.IResolvable | CfnGlobalTable.ReplicaStreamSpecificationProperty;
/**
* A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table.
*
* Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.
*
* In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see [Using resource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy
*/
readonly resourcePolicy?: cdk.IResolvable | CfnGlobalTable.ResourcePolicyProperty;
/**
* Allows you to specify a customer-managed key for the replica.
*
* When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-ssespecification
*/
readonly sseSpecification?: cdk.IResolvable | CfnGlobalTable.ReplicaSSESpecificationProperty;
/**
* The table class of the specified table.
*
* Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tableclass
*/
readonly tableClass?: string;
/**
* An array of key-value pairs to apply to this replica.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Allows you to specify a KMS key identifier to be used for server-side encryption.
*
* The key can be specified via ARN, key ID, or alias. The key must be created in the same region as the replica.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html
*/
interface ReplicaSSESpecificationProperty {
/**
* The AWS KMS key that should be used for the AWS KMS encryption.
*
* To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key `alias/aws/dynamodb` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html#cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid
*/
readonly kmsMasterKeyId: string;
}
/**
* The Kinesis Data Streams configuration for the specified global table replica.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html
*/
interface KinesisStreamSpecificationProperty {
/**
* The precision for the time and date that the stream was created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html#cfn-dynamodb-globaltable-kinesisstreamspecification-approximatecreationdatetimeprecision
*/
readonly approximateCreationDateTimePrecision?: string;
/**
* The ARN for a specific Kinesis data stream.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html#cfn-dynamodb-globaltable-kinesisstreamspecification-streamarn
*/
readonly streamArn: string;
}
/**
* Configures contributor insights settings for a replica or one of its indexes.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html
*/
interface ContributorInsightsSpecificationProperty {
/**
* Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html#cfn-dynamodb-globaltable-contributorinsightsspecification-enabled
*/
readonly enabled: boolean | cdk.IResolvable;
}
/**
* Represents the properties of a global secondary index that can be set on a per-replica basis.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html
*/
interface ReplicaGlobalSecondaryIndexSpecificationProperty {
/**
* Updates the status for contributor insights for a specific table or index.
*
* CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification
*/
readonly contributorInsightsSpecification?: CfnGlobalTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
/**
* The name of the global secondary index.
*
* The name must be unique among all other indexes on this table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname
*/
readonly indexName: string;
/**
* Sets the read request settings for a replica global secondary index.
*
* You can only specify this setting if your resource uses the `PAY_PER_REQUEST` `BillingMode` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readondemandthroughputsettings
*/
readonly readOnDemandThroughputSettings?: cdk.IResolvable | CfnGlobalTable.ReadOnDemandThroughputSettingsProperty;
/**
* Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings
*/
readonly readProvisionedThroughputSettings?: cdk.IResolvable | CfnGlobalTable.ReadProvisionedThroughputSettingsProperty;
}
/**
* Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .
*
* You must specify a value for either `ReadCapacityUnits` or `ReadCapacityAutoScalingSettings` , but not both. You can switch between fixed capacity and auto scaling.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html
*/
interface ReadProvisionedThroughputSettingsProperty {
/**
* Specifies auto scaling settings for the replica table or global secondary index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings
*/
readonly readCapacityAutoScalingSettings?: CfnGlobalTable.CapacityAutoScalingSettingsProperty | cdk.IResolvable;
/**
* Specifies a fixed read capacity for the replica table or global secondary index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits
*/
readonly readCapacityUnits?: number;
}
/**
* Sets the read request settings for a replica table or a replica global secondary index.
*
* You can only specify this setting if your resource uses the `PAY_PER_REQUEST` `BillingMode` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html
*/
interface ReadOnDemandThroughputSettingsProperty {
/**
* Maximum number of read request units for the specified replica of a global table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html#cfn-dynamodb-globaltable-readondemandthroughputsettings-maxreadrequestunits
*/
readonly maxReadRequestUnits?: number;
}
/**
* Represents the settings used to enable point in time recovery.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html
*/
interface PointInTimeRecoverySpecificationProperty {
/**
* Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html#cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled
*/
readonly pointInTimeRecoveryEnabled?: boolean | cdk.IResolvable;
/**
* The number of preceding days for which continuous backups are taken and maintained.
*
* Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html#cfn-dynamodb-globaltable-pointintimerecoveryspecification-recoverype