UNPKG

94.2 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnGlobalTable`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html
10 */
11export interface CfnGlobalTableProps {
12 /**
13 * A list of attributes that describe the key schema for the global table and indexes.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions
16 */
17 readonly attributeDefinitions: Array<CfnGlobalTable.AttributeDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
18 /**
19 * 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.
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema
22 */
23 readonly keySchema: Array<CfnGlobalTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
24 /**
25 * 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.
26 *
27 * > 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.
28 * >
29 * > 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.
30 *
31 * 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.
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
34 */
35 readonly replicas: Array<CfnGlobalTable.ReplicaSpecificationProperty | cdk.IResolvable> | cdk.IResolvable;
36 /**
37 * Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
38 *
39 * - `PAY_PER_REQUEST`
40 * - `PROVISIONED`
41 *
42 * 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` .
43 *
44 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode
45 */
46 readonly billingMode?: string;
47 /**
48 * 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.
49 *
50 * 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.
51 *
52 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globalsecondaryindexes
53 */
54 readonly globalSecondaryIndexes?: Array<CfnGlobalTable.GlobalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable;
55 /**
56 * 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.
57 *
58 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes
59 */
60 readonly localSecondaryIndexes?: Array<CfnGlobalTable.LocalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable;
61 /**
62 * 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.
63 *
64 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-ssespecification
65 */
66 readonly sseSpecification?: CfnGlobalTable.SSESpecificationProperty | cdk.IResolvable;
67 /**
68 * 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.
69 *
70 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification
71 */
72 readonly streamSpecification?: CfnGlobalTable.StreamSpecificationProperty | cdk.IResolvable;
73 /**
74 * 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) .
75 *
76 * > 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.
77 *
78 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename
79 */
80 readonly tableName?: string;
81 /**
82 * Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
83 *
84 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification
85 */
86 readonly timeToLiveSpecification?: CfnGlobalTable.TimeToLiveSpecificationProperty | cdk.IResolvable;
87 /**
88 * 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` .
89 *
90 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings
91 */
92 readonly writeProvisionedThroughputSettings?: CfnGlobalTable.WriteProvisionedThroughputSettingsProperty | cdk.IResolvable;
93}
94/**
95 * A CloudFormation `AWS::DynamoDB::GlobalTable`
96 *
97 * 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.
98 *
99 * > 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.*
100 * >
101 * > 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.
102 *
103 * You should be aware of the following behaviors when working with DynamoDB global tables.
104 *
105 * - 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.
106 *
107 * - `dynamodb:CreateTable`
108 * - `dynamodb:UpdateTable`
109 * - `dynamodb:DeleteTable`
110 * - `dynamodb:DescribeContinuousBackups`
111 * - `dynamodb:DescribeContributorInsights`
112 * - `dynamodb:DescribeTable`
113 * - `dynamodb:DescribeTableReplicaAutoScaling`
114 * - `dynamodb:DescribeTimeToLive`
115 * - `dynamodb:ListTables`
116 * - `dynamodb:UpdateTimeToLive`
117 * - `dynamodb:UpdateContributorInsights`
118 * - `dynamodb:UpdateContinuousBackups`
119 * - `dynamodb:ListTagsOfResource`
120 * - `dynamodb:TableClass`
121 * - `dynamodb:TagResource`
122 * - `dynamodb:UntagResource`
123 * - `dynamodb:BatchWriteItem`
124 * - `dynamodb:CreateTableReplica`
125 * - `dynamodb:DeleteItem`
126 * - `dynamodb:DeleteTableReplica`
127 * - `dynamodb:DisableKinesisStreamingDestination`
128 * - `dynamodb:EnableKinesisStreamingDestination`
129 * - `dynamodb:GetItem`
130 * - `dynamodb:PutItem`
131 * - `dynamodb:Query`
132 * - `dynamodb:Scan`
133 * - `dynamodb:UpdateItem`
134 * - `dynamodb:DescribeTableReplicaAutoScaling`
135 * - `dynamodb:UpdateTableReplicaAutoScaling`
136 * - `iam:CreateServiceLinkedRole`
137 * - `kms:CreateGrant`
138 * - `kms:DescribeKey`
139 * - `application-autoscaling:DeleteScalingPolicy`
140 * - `application-autoscaling:DeleteScheduledAction`
141 * - `application-autoscaling:DeregisterScalableTarget`
142 * - `application-autoscaling:DescribeScalingPolicies`
143 * - `application-autoscaling:DescribeScalableTargets`
144 * - `application-autoscaling:PutScalingPolicy`
145 * - `application-autoscaling:PutScheduledAction`
146 * - `application-autoscaling:RegisterScalableTarget`
147 * - 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.
148 * - 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.
149 * - 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.
150 *
151 * @cloudformationResource AWS::DynamoDB::GlobalTable
152 * @stability external
153 *
154 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html
155 */
156export declare class CfnGlobalTable extends cdk.CfnResource implements cdk.IInspectable {
157 /**
158 * The CloudFormation resource type name for this resource class.
159 */
160 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::DynamoDB::GlobalTable";
161 /**
162 * A factory method that creates a new instance of this class from an object
163 * containing the CloudFormation properties of this resource.
164 * Used in the @aws-cdk/cloudformation-include module.
165 *
166 * @internal
167 */
168 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGlobalTable;
169 /**
170 * 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.
171 * @cloudformationAttribute Arn
172 */
173 readonly attrArn: string;
174 /**
175 * 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.
176 *
177 * > You must specify the `StreamSpecification` property to use this attribute.
178 * @cloudformationAttribute StreamArn
179 */
180 readonly attrStreamArn: string;
181 /**
182 * 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.
183 * @cloudformationAttribute TableId
184 */
185 readonly attrTableId: string;
186 /**
187 * A list of attributes that describe the key schema for the global table and indexes.
188 *
189 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions
190 */
191 attributeDefinitions: Array<CfnGlobalTable.AttributeDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
192 /**
193 * 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.
194 *
195 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema
196 */
197 keySchema: Array<CfnGlobalTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
198 /**
199 * 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.
200 *
201 * > 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.
202 * >
203 * > 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.
204 *
205 * 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.
206 *
207 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
208 */
209 replicas: Array<CfnGlobalTable.ReplicaSpecificationProperty | cdk.IResolvable> | cdk.IResolvable;
210 /**
211 * Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
212 *
213 * - `PAY_PER_REQUEST`
214 * - `PROVISIONED`
215 *
216 * 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` .
217 *
218 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode
219 */
220 billingMode: string | undefined;
221 /**
222 * 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.
223 *
224 * 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.
225 *
226 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globalsecondaryindexes
227 */
228 globalSecondaryIndexes: Array<CfnGlobalTable.GlobalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
229 /**
230 * 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.
231 *
232 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes
233 */
234 localSecondaryIndexes: Array<CfnGlobalTable.LocalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
235 /**
236 * 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.
237 *
238 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-ssespecification
239 */
240 sseSpecification: CfnGlobalTable.SSESpecificationProperty | cdk.IResolvable | undefined;
241 /**
242 * 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.
243 *
244 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification
245 */
246 streamSpecification: CfnGlobalTable.StreamSpecificationProperty | cdk.IResolvable | undefined;
247 /**
248 * 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) .
249 *
250 * > 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.
251 *
252 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename
253 */
254 tableName: string | undefined;
255 /**
256 * Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
257 *
258 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification
259 */
260 timeToLiveSpecification: CfnGlobalTable.TimeToLiveSpecificationProperty | cdk.IResolvable | undefined;
261 /**
262 * 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` .
263 *
264 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings
265 */
266 writeProvisionedThroughputSettings: CfnGlobalTable.WriteProvisionedThroughputSettingsProperty | cdk.IResolvable | undefined;
267 /**
268 * Create a new `AWS::DynamoDB::GlobalTable`.
269 *
270 * @param scope - scope in which this resource is defined
271 * @param id - scoped id of the resource
272 * @param props - resource properties
273 */
274 constructor(scope: cdk.Construct, id: string, props: CfnGlobalTableProps);
275 /**
276 * Examines the CloudFormation resource and discloses attributes.
277 *
278 * @param inspector - tree inspector to collect and process attributes
279 *
280 */
281 inspect(inspector: cdk.TreeInspector): void;
282 protected get cfnProperties(): {
283 [key: string]: any;
284 };
285 protected renderProperties(props: {
286 [key: string]: any;
287 }): {
288 [key: string]: any;
289 };
290}
291export declare namespace CfnGlobalTable {
292 /**
293 * Represents an attribute for describing the key schema for the table and indexes.
294 *
295 * @struct
296 * @stability external
297 *
298 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html
299 */
300 interface AttributeDefinitionProperty {
301 /**
302 * A name for the attribute.
303 *
304 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributename
305 */
306 readonly attributeName: string;
307 /**
308 * The data type for the attribute, where:
309 *
310 * - `S` - the attribute is of type String
311 * - `N` - the attribute is of type Number
312 * - `B` - the attribute is of type Binary
313 *
314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributetype
315 */
316 readonly attributeType: string;
317 }
318}
319export declare namespace CfnGlobalTable {
320 /**
321 * Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.
322 *
323 * @struct
324 * @stability external
325 *
326 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html
327 */
328 interface CapacityAutoScalingSettingsProperty {
329 /**
330 * The maximum provisioned capacity units for the global table.
331 *
332 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity
333 */
334 readonly maxCapacity: number;
335 /**
336 * The minimum provisioned capacity units for the global table.
337 *
338 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity
339 */
340 readonly minCapacity: number;
341 /**
342 * 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.
343 *
344 * 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.
345 *
346 * 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` .
347 *
348 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity
349 */
350 readonly seedCapacity?: number;
351 /**
352 * Defines a target tracking scaling policy.
353 *
354 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration
355 */
356 readonly targetTrackingScalingPolicyConfiguration: CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty | cdk.IResolvable;
357 }
358}
359export declare namespace CfnGlobalTable {
360 /**
361 * Configures contributor insights settings for a replica or one of its indexes.
362 *
363 * @struct
364 * @stability external
365 *
366 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html
367 */
368 interface ContributorInsightsSpecificationProperty {
369 /**
370 * Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
371 *
372 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html#cfn-dynamodb-globaltable-contributorinsightsspecification-enabled
373 */
374 readonly enabled: boolean | cdk.IResolvable;
375 }
376}
377export declare namespace CfnGlobalTable {
378 /**
379 * Allows you to specify a global secondary index for the global table. The index will be defined on all replicas.
380 *
381 * @struct
382 * @stability external
383 *
384 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html
385 */
386 interface GlobalSecondaryIndexProperty {
387 /**
388 * The name of the global secondary index. The name must be unique among all other indexes on this table.
389 *
390 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-indexname
391 */
392 readonly indexName: string;
393 /**
394 * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
395 *
396 * - `HASH` - partition key
397 * - `RANGE` - sort key
398 *
399 * > 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.
400 * >
401 * > 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.
402 *
403 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema
404 */
405 readonly keySchema: Array<CfnGlobalTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
406 /**
407 * 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.
408 *
409 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-projection
410 */
411 readonly projection: CfnGlobalTable.ProjectionProperty | cdk.IResolvable;
412 /**
413 * 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.
414 *
415 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings
416 */
417 readonly writeProvisionedThroughputSettings?: CfnGlobalTable.WriteProvisionedThroughputSettingsProperty | cdk.IResolvable;
418 }
419}
420export declare namespace CfnGlobalTable {
421 /**
422 * 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.
423 *
424 * 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.
425 *
426 * 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.
427 *
428 * @struct
429 * @stability external
430 *
431 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html
432 */
433 interface KeySchemaProperty {
434 /**
435 * The name of a key attribute.
436 *
437 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-attributename
438 */
439 readonly attributeName: string;
440 /**
441 * The role that this key attribute will assume:
442 *
443 * - `HASH` - partition key
444 * - `RANGE` - sort key
445 *
446 * > 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.
447 * >
448 * > 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.
449 *
450 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-keytype
451 */
452 readonly keyType: string;
453 }
454}
455export declare namespace CfnGlobalTable {
456 /**
457 * Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.
458 *
459 * @struct
460 * @stability external
461 *
462 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html
463 */
464 interface LocalSecondaryIndexProperty {
465 /**
466 * The name of the local secondary index. The name must be unique among all other indexes on this table.
467 *
468 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-indexname
469 */
470 readonly indexName: string;
471 /**
472 * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
473 *
474 * - `HASH` - partition key
475 * - `RANGE` - sort key
476 *
477 * > 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.
478 * >
479 * > 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.
480 *
481 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-keyschema
482 */
483 readonly keySchema: Array<CfnGlobalTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
484 /**
485 * 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.
486 *
487 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-projection
488 */
489 readonly projection: CfnGlobalTable.ProjectionProperty | cdk.IResolvable;
490 }
491}
492export declare namespace CfnGlobalTable {
493 /**
494 * Represents the settings used to enable point in time recovery.
495 *
496 * @struct
497 * @stability external
498 *
499 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html
500 */
501 interface PointInTimeRecoverySpecificationProperty {
502 /**
503 * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
504 *
505 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html#cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled
506 */
507 readonly pointInTimeRecoveryEnabled?: boolean | cdk.IResolvable;
508 }
509}
510export declare namespace CfnGlobalTable {
511 /**
512 * 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.
513 *
514 * @struct
515 * @stability external
516 *
517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html
518 */
519 interface ProjectionProperty {
520 /**
521 * Represents the non-key attribute names which will be projected into the index.
522 *
523 * 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.
524 *
525 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-nonkeyattributes
526 */
527 readonly nonKeyAttributes?: string[];
528 /**
529 * The set of attributes that are projected into the index:
530 *
531 * - `KEYS_ONLY` - Only the index and primary keys are projected into the index.
532 * - `INCLUDE` - In addition to the attributes described in `KEYS_ONLY` , the secondary index will include other non-key attributes that you specify.
533 * - `ALL` - All of the table attributes are projected into the index.
534 *
535 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-projectiontype
536 */
537 readonly projectionType?: string;
538 }
539}
540export declare namespace CfnGlobalTable {
541 /**
542 * 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.
543 *
544 * @struct
545 * @stability external
546 *
547 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html
548 */
549 interface ReadProvisionedThroughputSettingsProperty {
550 /**
551 * Specifies auto scaling settings for the replica table or global secondary index.
552 *
553 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings
554 */
555 readonly readCapacityAutoScalingSettings?: CfnGlobalTable.CapacityAutoScalingSettingsProperty | cdk.IResolvable;
556 /**
557 * Specifies a fixed read capacity for the replica table or global secondary index.
558 *
559 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits
560 */
561 readonly readCapacityUnits?: number;
562 }
563}
564export declare namespace CfnGlobalTable {
565 /**
566 * Represents the properties of a global secondary index that can be set on a per-replica basis.
567 *
568 * @struct
569 * @stability external
570 *
571 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html
572 */
573 interface ReplicaGlobalSecondaryIndexSpecificationProperty {
574 /**
575 * 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.
576 *
577 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification
578 */
579 readonly contributorInsightsSpecification?: CfnGlobalTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
580 /**
581 * The name of the global secondary index. The name must be unique among all other indexes on this table.
582 *
583 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname
584 */
585 readonly indexName: string;
586 /**
587 * Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .
588 *
589 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings
590 */
591 readonly readProvisionedThroughputSettings?: CfnGlobalTable.ReadProvisionedThroughputSettingsProperty | cdk.IResolvable;
592 }
593}
594export declare namespace CfnGlobalTable {
595 /**
596 * 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.
597 *
598 * @struct
599 * @stability external
600 *
601 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html
602 */
603 interface ReplicaSSESpecificationProperty {
604 /**
605 * 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` .
606 *
607 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html#cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid
608 */
609 readonly kmsMasterKeyId: string;
610 }
611}
612export declare namespace CfnGlobalTable {
613 /**
614 * Defines settings specific to a single replica of a global table.
615 *
616 * @struct
617 * @stability external
618 *
619 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html
620 */
621 interface ReplicaSpecificationProperty {
622 /**
623 * 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.
624 *
625 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification
626 */
627 readonly contributorInsightsSpecification?: CfnGlobalTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
628 /**
629 * Defines additional settings for the global secondary indexes of this replica.
630 *
631 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes
632 */
633 readonly globalSecondaryIndexes?: Array<CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty | cdk.IResolvable> | cdk.IResolvable;
634 /**
635 * The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
636 *
637 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification
638 */
639 readonly pointInTimeRecoverySpecification?: CfnGlobalTable.PointInTimeRecoverySpecificationProperty | cdk.IResolvable;
640 /**
641 * Defines read capacity settings for the replica table.
642 *
643 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings
644 */
645 readonly readProvisionedThroughputSettings?: CfnGlobalTable.ReadProvisionedThroughputSettingsProperty | cdk.IResolvable;
646 /**
647 * The region in which this replica exists.
648 *
649 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-region
650 */
651 readonly region: string;
652 /**
653 * 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.
654 *
655 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-ssespecification
656 */
657 readonly sseSpecification?: CfnGlobalTable.ReplicaSSESpecificationProperty | cdk.IResolvable;
658 /**
659 * The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .
660 *
661 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tableclass
662 */
663 readonly tableClass?: string;
664 /**
665 * An array of key-value pairs to apply to this replica.
666 *
667 * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
668 *
669 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tags
670 */
671 readonly tags?: cdk.CfnTag[];
672 }
673}
674export declare namespace CfnGlobalTable {
675 /**
676 * Represents the settings used to enable server-side encryption.
677 *
678 * @struct
679 * @stability external
680 *
681 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html
682 */
683 interface SSESpecificationProperty {
684 /**
685 * Indicates whether server-side encryption is performed using an AWS managed key or an AWS owned key. If disabled (false) or not specified, server-side encryption uses an AWS owned key. If enabled (true), the server-side encryption type is set to KMS and an AWS managed key is used ( AWS KMS charges apply). 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.
686 *
687 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-sseenabled
688 */
689 readonly sseEnabled: boolean | cdk.IResolvable;
690 /**
691 * Server-side encryption type. The only supported value is:
692 *
693 * - `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).
694 *
695 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-ssetype
696 */
697 readonly sseType?: string;
698 }
699}
700export declare namespace CfnGlobalTable {
701 /**
702 * Represents the DynamoDB Streams configuration for a table in DynamoDB.
703 *
704 * 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.
705 *
706 * @struct
707 * @stability external
708 *
709 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html
710 */
711 interface StreamSpecificationProperty {
712 /**
713 * 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:
714 *
715 * - `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
716 * - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
717 * - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
718 * - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
719 *
720 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html#cfn-dynamodb-globaltable-streamspecification-streamviewtype
721 */
722 readonly streamViewType: string;
723 }
724}
725export declare namespace CfnGlobalTable {
726 /**
727 * Defines a target tracking scaling policy.
728 *
729 * @struct
730 * @stability external
731 *
732 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html
733 */
734 interface TargetTrackingScalingPolicyConfigurationProperty {
735 /**
736 * Indicates whether scale in by the target tracking scaling policy is disabled. The default value is `false` .
737 *
738 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein
739 */
740 readonly disableScaleIn?: boolean | cdk.IResolvable;
741 /**
742 * The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
743 *
744 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown
745 */
746 readonly scaleInCooldown?: number;
747 /**
748 * The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
749 *
750 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown
751 */
752 readonly scaleOutCooldown?: number;
753 /**
754 * Defines a target value for the scaling policy.
755 *
756 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue
757 */
758 readonly targetValue: number;
759 }
760}
761export declare namespace CfnGlobalTable {
762 /**
763 * 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.
764 *
765 * @struct
766 * @stability external
767 *
768 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html
769 */
770 interface TimeToLiveSpecificationProperty {
771 /**
772 * The name of the attribute used to store the expiration time for items in the table.
773 *
774 * 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.
775 *
776 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html#cfn-dynamodb-globaltable-timetolivespecification-attributename
777 */
778 readonly attributeName?: string;
779 /**
780 * Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
781 *
782 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html#cfn-dynamodb-globaltable-timetolivespecification-enabled
783 */
784 readonly enabled: boolean | cdk.IResolvable;
785 }
786}
787export declare namespace CfnGlobalTable {
788 /**
789 * 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` .
790 *
791 * @struct
792 * @stability external
793 *
794 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html
795 */
796 interface WriteProvisionedThroughputSettingsProperty {
797 /**
798 * Specifies auto scaling settings for the replica table or global secondary index.
799 *
800 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings
801 */
802 readonly writeCapacityAutoScalingSettings?: CfnGlobalTable.CapacityAutoScalingSettingsProperty | cdk.IResolvable;
803 }
804}
805/**
806 * Properties for defining a `CfnTable`
807 *
808 * @struct
809 * @stability external
810 *
811 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html
812 */
813export interface CfnTableProps {
814 /**
815 * 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.
816 *
817 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema
818 */
819 readonly keySchema: Array<CfnTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
820 /**
821 * A list of attributes that describe the key schema for the table and indexes.
822 *
823 * This property is required to create a DynamoDB table.
824 *
825 * 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.
826 *
827 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef
828 */
829 readonly attributeDefinitions?: Array<CfnTable.AttributeDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
830 /**
831 * Specify how you are charged for read and write throughput and how you manage capacity.
832 *
833 * Valid values include:
834 *
835 * - `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) .
836 * - `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) .
837 *
838 * If not specified, the default is `PROVISIONED` .
839 *
840 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode
841 */
842 readonly billingMode?: string;
843 /**
844 * The settings used to enable or disable CloudWatch Contributor Insights for the specified table.
845 *
846 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-contributorinsightsspecification-enabled
847 */
848 readonly contributorInsightsSpecification?: CfnTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
849 /**
850 * Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.
851 *
852 * > 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.
853 * >
854 * > 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.
855 * >
856 * > Updates are not supported. The following are exceptions:
857 * >
858 * > - If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
859 * > - 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.
860 *
861 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-gsi
862 */
863 readonly globalSecondaryIndexes?: Array<CfnTable.GlobalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable;
864 /**
865 * The Kinesis Data Streams configuration for the specified table.
866 *
867 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-kinesisstreamspecification
868 */
869 readonly kinesisStreamSpecification?: CfnTable.KinesisStreamSpecificationProperty | cdk.IResolvable;
870 /**
871 * 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.
872 *
873 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-lsi
874 */
875 readonly localSecondaryIndexes?: Array<CfnTable.LocalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable;
876 /**
877 * The settings used to enable point in time recovery.
878 *
879 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification
880 */
881 readonly pointInTimeRecoverySpecification?: CfnTable.PointInTimeRecoverySpecificationProperty | cdk.IResolvable;
882 /**
883 * 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/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) .
884 *
885 * If you set `BillingMode` as `PROVISIONED` , you must specify this property. If you set `BillingMode` as `PAY_PER_REQUEST` , you cannot specify this property.
886 *
887 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput
888 */
889 readonly provisionedThroughput?: CfnTable.ProvisionedThroughputProperty | cdk.IResolvable;
890 /**
891 * Specifies the settings to enable server-side encryption.
892 *
893 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification
894 */
895 readonly sseSpecification?: CfnTable.SSESpecificationProperty | cdk.IResolvable;
896 /**
897 * The settings for the DynamoDB table stream, which capture changes to items stored in the table.
898 *
899 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification
900 */
901 readonly streamSpecification?: CfnTable.StreamSpecificationProperty | cdk.IResolvable;
902 /**
903 * The table class of the new table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .
904 *
905 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tableclass
906 */
907 readonly tableClass?: string;
908 /**
909 * 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) .
910 *
911 * > 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.
912 *
913 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename
914 */
915 readonly tableName?: string;
916 /**
917 * An array of key-value pairs to apply to this resource.
918 *
919 * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
920 *
921 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags
922 */
923 readonly tags?: cdk.CfnTag[];
924 /**
925 * Specifies the Time to Live (TTL) settings for the table.
926 *
927 * > 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.
928 *
929 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification
930 */
931 readonly timeToLiveSpecification?: CfnTable.TimeToLiveSpecificationProperty | cdk.IResolvable;
932}
933/**
934 * A CloudFormation `AWS::DynamoDB::Table`
935 *
936 * The `AWS::DynamoDB::Table` resource creates a DynamoDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *Amazon DynamoDB API Reference* .
937 *
938 * You should be aware of the following behaviors when working with DynamoDB tables:
939 *
940 * - AWS CloudFormation typically creates DynamoDB tables in parallel. However, if your template includes multiple DynamoDB tables with indexes, you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute) .
941 *
942 * @cloudformationResource AWS::DynamoDB::Table
943 * @stability external
944 *
945 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html
946 */
947export declare class CfnTable extends cdk.CfnResource implements cdk.IInspectable {
948 /**
949 * The CloudFormation resource type name for this resource class.
950 */
951 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::DynamoDB::Table";
952 /**
953 * A factory method that creates a new instance of this class from an object
954 * containing the CloudFormation properties of this resource.
955 * Used in the @aws-cdk/cloudformation-include module.
956 *
957 * @internal
958 */
959 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTable;
960 /**
961 * The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable` .
962 * @cloudformationAttribute Arn
963 */
964 readonly attrArn: string;
965 /**
966 * 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` .
967 *
968 * > You must specify the `StreamSpecification` property to use this attribute.
969 * @cloudformationAttribute StreamArn
970 */
971 readonly attrStreamArn: string;
972 /**
973 * 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.
974 *
975 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema
976 */
977 keySchema: Array<CfnTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
978 /**
979 * A list of attributes that describe the key schema for the table and indexes.
980 *
981 * This property is required to create a DynamoDB table.
982 *
983 * 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.
984 *
985 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef
986 */
987 attributeDefinitions: Array<CfnTable.AttributeDefinitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
988 /**
989 * Specify how you are charged for read and write throughput and how you manage capacity.
990 *
991 * Valid values include:
992 *
993 * - `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) .
994 * - `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) .
995 *
996 * If not specified, the default is `PROVISIONED` .
997 *
998 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode
999 */
1000 billingMode: string | undefined;
1001 /**
1002 * The settings used to enable or disable CloudWatch Contributor Insights for the specified table.
1003 *
1004 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-contributorinsightsspecification-enabled
1005 */
1006 contributorInsightsSpecification: CfnTable.ContributorInsightsSpecificationProperty | cdk.IResolvable | undefined;
1007 /**
1008 * Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.
1009 *
1010 * > 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.
1011 * >
1012 * > 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.
1013 * >
1014 * > Updates are not supported. The following are exceptions:
1015 * >
1016 * > - If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
1017 * > - 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.
1018 *
1019 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-gsi
1020 */
1021 globalSecondaryIndexes: Array<CfnTable.GlobalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1022 /**
1023 * The Kinesis Data Streams configuration for the specified table.
1024 *
1025 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-kinesisstreamspecification
1026 */
1027 kinesisStreamSpecification: CfnTable.KinesisStreamSpecificationProperty | cdk.IResolvable | undefined;
1028 /**
1029 * 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.
1030 *
1031 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-lsi
1032 */
1033 localSecondaryIndexes: Array<CfnTable.LocalSecondaryIndexProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1034 /**
1035 * The settings used to enable point in time recovery.
1036 *
1037 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification
1038 */
1039 pointInTimeRecoverySpecification: CfnTable.PointInTimeRecoverySpecificationProperty | cdk.IResolvable | undefined;
1040 /**
1041 * 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/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) .
1042 *
1043 * If you set `BillingMode` as `PROVISIONED` , you must specify this property. If you set `BillingMode` as `PAY_PER_REQUEST` , you cannot specify this property.
1044 *
1045 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput
1046 */
1047 provisionedThroughput: CfnTable.ProvisionedThroughputProperty | cdk.IResolvable | undefined;
1048 /**
1049 * Specifies the settings to enable server-side encryption.
1050 *
1051 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification
1052 */
1053 sseSpecification: CfnTable.SSESpecificationProperty | cdk.IResolvable | undefined;
1054 /**
1055 * The settings for the DynamoDB table stream, which capture changes to items stored in the table.
1056 *
1057 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification
1058 */
1059 streamSpecification: CfnTable.StreamSpecificationProperty | cdk.IResolvable | undefined;
1060 /**
1061 * The table class of the new table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .
1062 *
1063 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tableclass
1064 */
1065 tableClass: string | undefined;
1066 /**
1067 * 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) .
1068 *
1069 * > 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.
1070 *
1071 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename
1072 */
1073 tableName: string | undefined;
1074 /**
1075 * An array of key-value pairs to apply to this resource.
1076 *
1077 * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
1078 *
1079 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags
1080 */
1081 readonly tags: cdk.TagManager;
1082 /**
1083 * Specifies the Time to Live (TTL) settings for the table.
1084 *
1085 * > 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.
1086 *
1087 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification
1088 */
1089 timeToLiveSpecification: CfnTable.TimeToLiveSpecificationProperty | cdk.IResolvable | undefined;
1090 /**
1091 * Create a new `AWS::DynamoDB::Table`.
1092 *
1093 * @param scope - scope in which this resource is defined
1094 * @param id - scoped id of the resource
1095 * @param props - resource properties
1096 */
1097 constructor(scope: cdk.Construct, id: string, props: CfnTableProps);
1098 /**
1099 * Examines the CloudFormation resource and discloses attributes.
1100 *
1101 * @param inspector - tree inspector to collect and process attributes
1102 *
1103 */
1104 inspect(inspector: cdk.TreeInspector): void;
1105 protected get cfnProperties(): {
1106 [key: string]: any;
1107 };
1108 protected renderProperties(props: {
1109 [key: string]: any;
1110 }): {
1111 [key: string]: any;
1112 };
1113}
1114export declare namespace CfnTable {
1115 /**
1116 * Represents an attribute for describing the key schema for the table and indexes.
1117 *
1118 * @struct
1119 * @stability external
1120 *
1121 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html
1122 */
1123 interface AttributeDefinitionProperty {
1124 /**
1125 * A name for the attribute.
1126 *
1127 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename
1128 */
1129 readonly attributeName: string;
1130 /**
1131 * The data type for the attribute, where:
1132 *
1133 * - `S` - the attribute is of type String
1134 * - `N` - the attribute is of type Number
1135 * - `B` - the attribute is of type Binary
1136 *
1137 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype
1138 */
1139 readonly attributeType: string;
1140 }
1141}
1142export declare namespace CfnTable {
1143 /**
1144 * The settings used to enable or disable CloudWatch Contributor Insights.
1145 *
1146 * @struct
1147 * @stability external
1148 *
1149 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html
1150 */
1151 interface ContributorInsightsSpecificationProperty {
1152 /**
1153 * Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
1154 *
1155 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html#cfn-dynamodb-contributorinsightsspecification-enabled
1156 */
1157 readonly enabled: boolean | cdk.IResolvable;
1158 }
1159}
1160export declare namespace CfnTable {
1161 /**
1162 * Represents the properties of a global secondary index.
1163 *
1164 * @struct
1165 * @stability external
1166 *
1167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html
1168 */
1169 interface GlobalSecondaryIndexProperty {
1170 /**
1171 * The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
1172 *
1173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-contributorinsightsspecification-enabled
1174 */
1175 readonly contributorInsightsSpecification?: CfnTable.ContributorInsightsSpecificationProperty | cdk.IResolvable;
1176 /**
1177 * The name of the global secondary index. The name must be unique among all other indexes on this table.
1178 *
1179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-indexname
1180 */
1181 readonly indexName: string;
1182 /**
1183 * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
1184 *
1185 * - `HASH` - partition key
1186 * - `RANGE` - sort key
1187 *
1188 * > 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.
1189 * >
1190 * > 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.
1191 *
1192 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-keyschema
1193 */
1194 readonly keySchema: Array<CfnTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
1195 /**
1196 * 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.
1197 *
1198 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-projection
1199 */
1200 readonly projection: CfnTable.ProjectionProperty | cdk.IResolvable;
1201 /**
1202 * Represents the provisioned throughput settings for the specified global secondary index.
1203 *
1204 * For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide* .
1205 *
1206 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-provisionedthroughput
1207 */
1208 readonly provisionedThroughput?: CfnTable.ProvisionedThroughputProperty | cdk.IResolvable;
1209 }
1210}
1211export declare namespace CfnTable {
1212 /**
1213 * 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.
1214 *
1215 * 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.
1216 *
1217 * 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.
1218 *
1219 * @struct
1220 * @stability external
1221 *
1222 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html
1223 */
1224 interface KeySchemaProperty {
1225 /**
1226 * The name of a key attribute.
1227 *
1228 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename
1229 */
1230 readonly attributeName: string;
1231 /**
1232 * The role that this key attribute will assume:
1233 *
1234 * - `HASH` - partition key
1235 * - `RANGE` - sort key
1236 *
1237 * > 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.
1238 * >
1239 * > 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.
1240 *
1241 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-keytype
1242 */
1243 readonly keyType: string;
1244 }
1245}
1246export declare namespace CfnTable {
1247 /**
1248 * The Kinesis Data Streams configuration for the specified table.
1249 *
1250 * @struct
1251 * @stability external
1252 *
1253 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-kinesisstreamspecification.html
1254 */
1255 interface KinesisStreamSpecificationProperty {
1256 /**
1257 * The ARN for a specific Kinesis data stream.
1258 *
1259 * Length Constraints: Minimum length of 37. Maximum length of 1024.
1260 *
1261 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-kinesisstreamspecification.html#cfn-dynamodb-kinesisstreamspecification-streamarn
1262 */
1263 readonly streamArn: string;
1264 }
1265}
1266export declare namespace CfnTable {
1267 /**
1268 * Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.
1269 *
1270 * @struct
1271 * @stability external
1272 *
1273 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html
1274 */
1275 interface LocalSecondaryIndexProperty {
1276 /**
1277 * The name of the local secondary index. The name must be unique among all other indexes on this table.
1278 *
1279 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-indexname
1280 */
1281 readonly indexName: string;
1282 /**
1283 * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
1284 *
1285 * - `HASH` - partition key
1286 * - `RANGE` - sort key
1287 *
1288 * > 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.
1289 * >
1290 * > 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.
1291 *
1292 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-keyschema
1293 */
1294 readonly keySchema: Array<CfnTable.KeySchemaProperty | cdk.IResolvable> | cdk.IResolvable;
1295 /**
1296 * 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.
1297 *
1298 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-projection
1299 */
1300 readonly projection: CfnTable.ProjectionProperty | cdk.IResolvable;
1301 }
1302}
1303export declare namespace CfnTable {
1304 /**
1305 * The settings used to enable point in time recovery.
1306 *
1307 * @struct
1308 * @stability external
1309 *
1310 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html
1311 */
1312 interface PointInTimeRecoverySpecificationProperty {
1313 /**
1314 * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
1315 *
1316 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled
1317 */
1318 readonly pointInTimeRecoveryEnabled?: boolean | cdk.IResolvable;
1319 }
1320}
1321export declare namespace CfnTable {
1322 /**
1323 * 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.
1324 *
1325 * @struct
1326 * @stability external
1327 *
1328 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html
1329 */
1330 interface ProjectionProperty {
1331 /**
1332 * Represents the non-key attribute names which will be projected into the index.
1333 *
1334 * 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.
1335 *
1336 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-nonkeyatt
1337 */
1338 readonly nonKeyAttributes?: string[];
1339 /**
1340 * The set of attributes that are projected into the index:
1341 *
1342 * - `KEYS_ONLY` - Only the index and primary keys are projected into the index.
1343 * - `INCLUDE` - In addition to the attributes described in `KEYS_ONLY` , the secondary index will include other non-key attributes that you specify.
1344 * - `ALL` - All of the table attributes are projected into the index.
1345 *
1346 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-projtype
1347 */
1348 readonly projectionType?: string;
1349 }
1350}
1351export declare namespace CfnTable {
1352 /**
1353 * 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/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) .
1354 *
1355 * @struct
1356 * @stability external
1357 *
1358 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html
1359 */
1360 interface ProvisionedThroughputProperty {
1361 /**
1362 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException` . For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide* .
1363 *
1364 * If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0.
1365 *
1366 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-readcapacityunits
1367 */
1368 readonly readCapacityUnits: number;
1369 /**
1370 * The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException` . For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide* .
1371 *
1372 * If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0.
1373 *
1374 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-writecapacityunits
1375 */
1376 readonly writeCapacityUnits: number;
1377 }
1378}
1379export declare namespace CfnTable {
1380 /**
1381 * Represents the settings used to enable server-side encryption.
1382 *
1383 * @struct
1384 * @stability external
1385 *
1386 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html
1387 */
1388 interface SSESpecificationProperty {
1389 /**
1390 * 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` .
1391 *
1392 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-kmsmasterkeyid
1393 */
1394 readonly kmsMasterKeyId?: string;
1395 /**
1396 * Indicates whether server-side encryption is done 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 AWS owned key.
1397 *
1398 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-sseenabled
1399 */
1400 readonly sseEnabled: boolean | cdk.IResolvable;
1401 /**
1402 * Server-side encryption type. The only supported value is:
1403 *
1404 * - `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).
1405 *
1406 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-ssetype
1407 */
1408 readonly sseType?: string;
1409 }
1410}
1411export declare namespace CfnTable {
1412 /**
1413 * Represents the DynamoDB Streams configuration for a table in DynamoDB.
1414 *
1415 * @struct
1416 * @stability external
1417 *
1418 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html
1419 */
1420 interface StreamSpecificationProperty {
1421 /**
1422 * 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:
1423 *
1424 * - `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
1425 * - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
1426 * - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
1427 * - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
1428 *
1429 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html#cfn-dynamodb-streamspecification-streamviewtype
1430 */
1431 readonly streamViewType: string;
1432 }
1433}
1434export declare namespace CfnTable {
1435 /**
1436 * Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
1437 *
1438 * @struct
1439 * @stability external
1440 *
1441 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html
1442 */
1443 interface TimeToLiveSpecificationProperty {
1444 /**
1445 * The name of the TTL attribute used to store the expiration time for items in the table.
1446 *
1447 * > To update this property, you must first disable TTL then enable TTL with the new attribute name.
1448 *
1449 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-attributename
1450 */
1451 readonly attributeName: string;
1452 /**
1453 * Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
1454 *
1455 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-enabled
1456 */
1457 readonly enabled: boolean | cdk.IResolvable;
1458 }
1459}