@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-dynamodb-globaltable.d.ts

@@ -0,0 +1,608 @@
+import type { ResourceDefinitionWithAttributes, Tag, TemplatePolicyDocument } from "../main.ts";
+export type DynamoDBGlobalTable = ResourceDefinitionWithAttributes<"AWS::DynamoDB::GlobalTable", DynamoDBGlobalTableProps, DynamoDBGlobalTableAttribs>;
+/**
+ * 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.
+ */
+export type DynamoDBGlobalTableProps = {
+    /**
+     * A list of attributes that describe the key schema for the global table and indexes.
+     */
+    AttributeDefinitions: AttributeDefinition[];
+    /**
+     * 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` .
+     */
+    BillingMode?: string | undefined;
+    /**
+     * 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.
+     */
+    GlobalSecondaryIndexes?: GlobalSecondaryIndex[] | undefined;
+    /**
+     * 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.
+     */
+    KeySchema: KeySchema[];
+    /**
+     * 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.
+     */
+    LocalSecondaryIndexes?: LocalSecondaryIndex[] | undefined;
+    /**
+     * 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.
+     */
+    Replicas: ReplicaSpecification[];
+    /**
+     * 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.
+     */
+    SSESpecification?: SSESpecification | undefined;
+    /**
+     * 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.
+     */
+    StreamSpecification?: StreamSpecification | undefined;
+    /**
+     * 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.
+     */
+    TableName?: string | undefined;
+    /**
+     * Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
+     */
+    TimeToLiveSpecification?: TimeToLiveSpecification | undefined;
+    /**
+     * 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.
+     */
+    WarmThroughput?: WarmThroughput | undefined;
+    /**
+     * 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` .
+     */
+    WriteOnDemandThroughputSettings?: WriteOnDemandThroughputSettings | undefined;
+    /**
+     * 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` .
+     */
+    WriteProvisionedThroughputSettings?: WriteProvisionedThroughputSettings | undefined;
+};
+export type DynamoDBGlobalTableAttribs = {
+    /**
+     * 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: 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: 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: string;
+};
+/**
+ * Represents an attribute for describing the schema for the table and indexes.
+ */
+export type AttributeDefinition = {
+    /**
+     * A name for the attribute.
+     * @minLength 1
+     * @maxLength 255
+     */
+    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
+     */
+    AttributeType: string;
+};
+/**
+ * Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.
+ */
+export type CapacityAutoScalingSettings = {
+    /**
+     * The maximum provisioned capacity units for the global table.
+     * @min 1
+     */
+    MaxCapacity: number;
+    /**
+     * The minimum provisioned capacity units for the global table.
+     * @min 1
+     */
+    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` .
+     * @min 1
+     */
+    SeedCapacity?: number | undefined;
+    /**
+     * Defines a target tracking scaling policy.
+     */
+    TargetTrackingScalingPolicyConfiguration: TargetTrackingScalingPolicyConfiguration;
+};
+/**
+ * Configures contributor insights settings for a replica or one of its indexes.
+ */
+export type ContributorInsightsSpecification = {
+    /**
+     * Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
+     */
+    Enabled: boolean;
+};
+/**
+ * Allows you to specify a global secondary index for the global table. The index will be defined on all replicas.
+ */
+export type GlobalSecondaryIndex = {
+    /**
+     * The name of the global secondary index. The name must be unique among all other indexes on this table.
+     * @minLength 3
+     * @maxLength 255
+     */
+    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.
+     */
+    KeySchema: KeySchema[];
+    /**
+     * 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.
+     */
+    Projection: Projection;
+    /**
+     * 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.
+     */
+    WarmThroughput?: WarmThroughput | undefined;
+    /**
+     * 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` .
+     */
+    WriteOnDemandThroughputSettings?: WriteOnDemandThroughputSettings | undefined;
+    /**
+     * 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.
+     */
+    WriteProvisionedThroughputSettings?: WriteProvisionedThroughputSettings | undefined;
+};
+/**
+ * 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.
+ */
+export type KeySchema = {
+    /**
+     * The name of a key attribute.
+     * @minLength 1
+     * @maxLength 255
+     */
+    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.
+     */
+    KeyType: string;
+};
+/**
+ * The Kinesis Data Streams configuration for the specified global table replica.
+ */
+export type KinesisStreamSpecification = {
+    /**
+     * The precision for the time and date that the stream was created.
+     */
+    ApproximateCreationDateTimePrecision?: "MICROSECOND" | "MILLISECOND" | undefined;
+    /**
+     * The ARN for a specific Kinesis data stream.
+     */
+    StreamArn: string;
+};
+/**
+ * Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.
+ */
+export type LocalSecondaryIndex = {
+    /**
+     * The name of the local secondary index. The name must be unique among all other indexes on this table.
+     * @minLength 3
+     * @maxLength 255
+     */
+    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.
+     */
+    KeySchema: KeySchema[];
+    /**
+     * 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.
+     */
+    Projection: Projection;
+};
+/**
+ * Represents the settings used to enable point in time recovery.
+ */
+export type PointInTimeRecoverySpecification = {
+    /**
+     * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
+     */
+    PointInTimeRecoveryEnabled?: boolean | undefined;
+    /**
+     * 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.
+     * @min 1
+     * @max 35
+     */
+    RecoveryPeriodInDays?: number | undefined;
+};
+/**
+ * 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.
+ */
+export type Projection = {
+    /**
+     * Represents the non-key attribute names which will be projected into the index.
+     *
+     * For global and local secondary indexes, the total count of `NonKeyAttributes` summed across all of the 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. This limit only applies when you specify the ProjectionType of `INCLUDE` . You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.
+     */
+    NonKeyAttributes?: string[] | undefined;
+    /**
+     * 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.
+     */
+    ProjectionType?: string | undefined;
+};
+/**
+ * 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` .
+ */
+export type ReadOnDemandThroughputSettings = {
+    /**
+     * Maximum number of read request units for the specified replica of a global table.
+     * @min 1
+     */
+    MaxReadRequestUnits?: number | undefined;
+};
+/**
+ * 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.
+ */
+export type ReadProvisionedThroughputSettings = {
+    /**
+     * Specifies auto scaling settings for the replica table or global secondary index.
+     */
+    ReadCapacityAutoScalingSettings?: CapacityAutoScalingSettings | undefined;
+    /**
+     * Specifies a fixed read capacity for the replica table or global secondary index.
+     * @min 1
+     */
+    ReadCapacityUnits?: number | undefined;
+};
+/**
+ * Represents the properties of a global secondary index that can be set on a per-replica basis.
+ */
+export type ReplicaGlobalSecondaryIndexSpecification = {
+    /**
+     * 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.
+     */
+    ContributorInsightsSpecification?: ContributorInsightsSpecification | undefined;
+    /**
+     * The name of the global secondary index. The name must be unique among all other indexes on this table.
+     * @minLength 3
+     * @maxLength 255
+     */
+    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` .
+     */
+    ReadOnDemandThroughputSettings?: ReadOnDemandThroughputSettings | undefined;
+    /**
+     * Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .
+     */
+    ReadProvisionedThroughputSettings?: ReadProvisionedThroughputSettings | undefined;
+};
+/**
+ * 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.
+ */
+export type ReplicaSSESpecification = {
+    /**
+     * 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` .
+     */
+    KMSMasterKeyId: string;
+};
+/**
+ * Defines settings specific to a single replica of a global table.
+ */
+export type ReplicaSpecification = {
+    /**
+     * 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.
+     */
+    ContributorInsightsSpecification?: ContributorInsightsSpecification | undefined;
+    /**
+     * 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* .
+     */
+    DeletionProtectionEnabled?: boolean | undefined;
+    /**
+     * Defines additional settings for the global secondary indexes of this replica.
+     */
+    GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndexSpecification[] | undefined;
+    /**
+     * Defines the Kinesis Data Streams configuration for the specified replica.
+     */
+    KinesisStreamSpecification?: KinesisStreamSpecification | undefined;
+    /**
+     * The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
+     */
+    PointInTimeRecoverySpecification?: PointInTimeRecoverySpecification | undefined;
+    /**
+     * Sets read request settings for the replica table.
+     */
+    ReadOnDemandThroughputSettings?: ReadOnDemandThroughputSettings | undefined;
+    /**
+     * Defines read capacity settings for the replica table.
+     */
+    ReadProvisionedThroughputSettings?: ReadProvisionedThroughputSettings | undefined;
+    /**
+     * The region in which this replica exists.
+     */
+    Region: string;
+    /**
+     * Represents the DynamoDB Streams configuration for a global table replica.
+     */
+    ReplicaStreamSpecification?: ReplicaStreamSpecification | undefined;
+    /**
+     * 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) .
+     */
+    ResourcePolicy?: ResourcePolicy | undefined;
+    /**
+     * 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.
+     */
+    SSESpecification?: ReplicaSSESpecification | undefined;
+    /**
+     * The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .
+     */
+    TableClass?: string | undefined;
+    /**
+     * 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) .
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * Represents the DynamoDB Streams configuration for a global table replica.
+ */
+export type ReplicaStreamSpecification = {
+    /**
+     * A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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) .
+     *
+     * You can update the `ResourcePolicy` property if you've specified more than one table using the [AWS ::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource.
+     */
+    ResourcePolicy: ResourcePolicy;
+};
+/**
+ * Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream. 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) .
+ *
+ * While defining resource-based policies in your CloudFormation templates, the following considerations apply:
+ *
+ * - The maximum size supported for a resource-based policy document in JSON format is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
+ * - Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#) . If you update a policy outside of the CloudFormation stack template, you'll need to update the CloudFormation stack with the changes.
+ * - Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CloudFormation template, the change won't be overwritten if there are no changes to the policy within the template.
+ *
+ * For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DynamoDB won’t be synced with the policy in the template.
+ *
+ * Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DynamoDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DynamoDB will be updated to match the one defined in the template.
+ * - Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
+ * - The [AWS ::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource doesn't support creating a replica in the same stack update in Regions other than the Region where you deploy the stack update.
+ *
+ * For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html) .
+ */
+export type ResourcePolicy = {
+    /**
+     * A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. 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) .
+     * @policy
+     */
+    PolicyDocument: TemplatePolicyDocument;
+};
+/**
+ * Represents the settings used to enable server-side encryption.
+ */
+export type SSESpecification = {
+    /**
+     * 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.
+     */
+    SSEEnabled: boolean;
+    /**
+     * 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).
+     */
+    SSEType?: string | undefined;
+};
+/**
+ * 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.
+ */
+export type StreamSpecification = {
+    /**
+     * 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.
+     */
+    StreamViewType: string;
+};
+/**
+ * Defines a target tracking scaling policy.
+ */
+export type TargetTrackingScalingPolicyConfiguration = {
+    /**
+     * Indicates whether scale in by the target tracking scaling policy is disabled. The default value is `false` .
+     */
+    DisableScaleIn?: boolean | undefined;
+    /**
+     * The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
+     * @min 0
+     */
+    ScaleInCooldown?: number | undefined;
+    /**
+     * The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
+     * @min 0
+     */
+    ScaleOutCooldown?: number | undefined;
+    /**
+     * Defines a target value for the scaling policy.
+     * @format double
+     */
+    TargetValue: number;
+};
+/**
+ * Represents the settings used to enable or disable Time to Live (TTL) for the specified table. All replicas will have the same time to live configuration.
+ */
+export type TimeToLiveSpecification = {
+    /**
+     * The name of the attribute used to store the expiration time for items in the table.
+     *
+     * Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
+     */
+    AttributeName?: string | undefined;
+    /**
+     * Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
+     */
+    Enabled: boolean;
+};
+/**
+ * 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.
+ */
+export type WarmThroughput = {
+    /**
+     * Represents the number of read operations your base table can instantaneously support.
+     * @min 1
+     */
+    ReadUnitsPerSecond: number;
+    /**
+     * Represents the number of write operations your base table can instantaneously support.
+     * @min 1
+     */
+    WriteUnitsPerSecond?: number | undefined;
+} | {
+    /**
+     * Represents the number of read operations your base table can instantaneously support.
+     * @min 1
+     */
+    ReadUnitsPerSecond?: number | undefined;
+    /**
+     * Represents the number of write operations your base table can instantaneously support.
+     * @min 1
+     */
+    WriteUnitsPerSecond: 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` .
+ */
+export type WriteOnDemandThroughputSettings = {
+    /**
+     * Maximum number of write request settings for the specified replica of a global table.
+     * @min 1
+     */
+    MaxWriteRequestUnits?: number | undefined;
+};
+/**
+ * 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` .
+ */
+export type WriteProvisionedThroughputSettings = {
+    /**
+     * Specifies auto scaling settings for the replica table or global secondary index.
+     */
+    WriteCapacityAutoScalingSettings?: CapacityAutoScalingSettings | undefined;
+};
+//# sourceMappingURL=aws-dynamodb-globaltable.d.ts.map