@awboost/cfn-resource-types 0.1.318 → 0.1.319
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -3,7 +3,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
3
3
|
/**
|
|
4
4
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
5
5
|
You should be aware of the following behaviors when working with DDB tables:
|
|
6
|
-
+
|
|
6
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong 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, DDB 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).
|
|
7
7
|
|
|
8
8
|
Our guidance is to use the latest schema documented for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -18,8 +18,8 @@ export type DynamoDBTableProperties = {
|
|
|
18
18
|
/**
|
|
19
19
|
* Specify how you are charged for read and write throughput and how you manage capacity.
|
|
20
20
|
Valid values include:
|
|
21
|
-
+
|
|
22
|
-
+
|
|
21
|
+
+ ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for most DynamoDB workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).
|
|
22
|
+
+ ``PROVISIONED`` - We recommend using ``PROVISIONED`` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. ``PROVISIONED`` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).
|
|
23
23
|
|
|
24
24
|
If not specified, the default is ``PROVISIONED``.
|
|
25
25
|
*/
|
|
@@ -128,9 +128,9 @@ export type AttributeDefinition = {
|
|
|
128
128
|
AttributeName: string;
|
|
129
129
|
/**
|
|
130
130
|
* The data type for the attribute, where:
|
|
131
|
-
+
|
|
132
|
-
+
|
|
133
|
-
+
|
|
131
|
+
+ ``S`` - the attribute is of type String
|
|
132
|
+
+ ``N`` - the attribute is of type Number
|
|
133
|
+
+ ``B`` - the attribute is of type Binary
|
|
134
134
|
*/
|
|
135
135
|
AttributeType: string;
|
|
136
136
|
};
|
|
@@ -176,8 +176,8 @@ export type GlobalSecondaryIndex = {
|
|
|
176
176
|
IndexName: string;
|
|
177
177
|
/**
|
|
178
178
|
* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
|
|
179
|
-
+
|
|
180
|
-
+
|
|
179
|
+
+ ``HASH`` - partition key
|
|
180
|
+
+ ``RANGE`` - sort key
|
|
181
181
|
|
|
182
182
|
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.
|
|
183
183
|
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.
|
|
@@ -249,8 +249,8 @@ export type KeySchema = {
|
|
|
249
249
|
AttributeName: string;
|
|
250
250
|
/**
|
|
251
251
|
* The role that this key attribute will assume:
|
|
252
|
-
+
|
|
253
|
-
+
|
|
252
|
+
+ ``HASH`` - partition key
|
|
253
|
+
+ ``RANGE`` - sort key
|
|
254
254
|
|
|
255
255
|
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.
|
|
256
256
|
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.
|
|
@@ -285,8 +285,8 @@ export type LocalSecondaryIndex = {
|
|
|
285
285
|
IndexName: string;
|
|
286
286
|
/**
|
|
287
287
|
* The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
|
|
288
|
-
+
|
|
289
|
-
+
|
|
288
|
+
+ ``HASH`` - partition key
|
|
289
|
+
+ ``RANGE`` - sort key
|
|
290
290
|
|
|
291
291
|
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.
|
|
292
292
|
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.
|
|
@@ -346,9 +346,9 @@ export type Projection = {
|
|
|
346
346
|
NonKeyAttributes?: string[];
|
|
347
347
|
/**
|
|
348
348
|
* The set of attributes that are projected into the index:
|
|
349
|
-
+
|
|
350
|
-
+
|
|
351
|
-
+
|
|
349
|
+
+ ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.
|
|
350
|
+
+ ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.
|
|
351
|
+
+ ``ALL`` - All of the table attributes are projected into the index.
|
|
352
352
|
|
|
353
353
|
When using the DynamoDB console, ``ALL`` is selected by default.
|
|
354
354
|
*/
|
|
@@ -426,7 +426,7 @@ export type SSESpecification = {
|
|
|
426
426
|
SSEEnabled: boolean;
|
|
427
427
|
/**
|
|
428
428
|
* Server-side encryption type. The only supported value is:
|
|
429
|
-
+
|
|
429
|
+
+ ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
|
|
430
430
|
*/
|
|
431
431
|
SSEType?: string;
|
|
432
432
|
};
|
|
@@ -443,17 +443,17 @@ export type StreamSpecification = {
|
|
|
443
443
|
ResourcePolicy?: ResourcePolicy;
|
|
444
444
|
/**
|
|
445
445
|
* 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:
|
|
446
|
-
+
|
|
447
|
-
+
|
|
448
|
-
+
|
|
449
|
-
+
|
|
446
|
+
+ ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.
|
|
447
|
+
+ ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.
|
|
448
|
+
+ ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.
|
|
449
|
+
+ ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream.
|
|
450
450
|
*/
|
|
451
451
|
StreamViewType: string;
|
|
452
452
|
};
|
|
453
453
|
/**
|
|
454
454
|
* Type definition for `AWS::DynamoDB::Table.Tag`.
|
|
455
455
|
* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
|
|
456
|
-
|
|
456
|
+
AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag.
|
|
457
457
|
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.
|
|
458
458
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-tag.html}
|
|
459
459
|
*/
|
|
@@ -504,7 +504,7 @@ export type WarmThroughput = {
|
|
|
504
504
|
/**
|
|
505
505
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
506
506
|
You should be aware of the following behaviors when working with DDB tables:
|
|
507
|
-
+
|
|
507
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong 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, DDB 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).
|
|
508
508
|
|
|
509
509
|
Our guidance is to use the latest schema documented for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
510
510
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -2,7 +2,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
2
2
|
/**
|
|
3
3
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
4
4
|
You should be aware of the following behaviors when working with DDB tables:
|
|
5
|
-
+
|
|
5
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong 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, DDB 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).
|
|
6
6
|
|
|
7
7
|
Our guidance is to use the latest schema documented for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
8
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -299,11 +299,11 @@ export type FilterConfiguration = {
|
|
|
299
299
|
*/
|
|
300
300
|
export type ForceEndpointErrorConfiguration = {
|
|
301
301
|
/**
|
|
302
|
-
* <p>The failover
|
|
302
|
+
* <p>The failover conditions for the endpoint. The options are:</p>
|
|
303
303
|
<ul>
|
|
304
304
|
<li>
|
|
305
305
|
<p>
|
|
306
|
-
<code>STALE_MANIFEST</code> - The manifest stalled and there
|
|
306
|
+
<code>STALE_MANIFEST</code> - The manifest stalled and there are no new segments or parts.</p>
|
|
307
307
|
</li>
|
|
308
308
|
<li>
|
|
309
309
|
<p>
|
|
@@ -313,6 +313,10 @@ export type ForceEndpointErrorConfiguration = {
|
|
|
313
313
|
<p>
|
|
314
314
|
<code>MISSING_DRM_KEY</code> - Key rotation is enabled but we're unable to fetch the key for the current key period.</p>
|
|
315
315
|
</li>
|
|
316
|
+
<li>
|
|
317
|
+
<p>
|
|
318
|
+
<code>SLATE_INPUT</code> - The segments which contain slate content are considered to be missing content.</p>
|
|
319
|
+
</li>
|
|
316
320
|
</ul>
|
|
317
321
|
*/
|
|
318
322
|
EndpointErrorConditions?: EndpointErrorCondition[];
|
|
@@ -348,8 +352,7 @@ export type HlsManifestConfiguration = {
|
|
|
348
352
|
/**
|
|
349
353
|
* <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
|
|
350
354
|
EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
|
|
351
|
-
The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player
|
|
352
|
-
ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.</p>
|
|
355
|
+
The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.</p>
|
|
353
356
|
<p>Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.</p>
|
|
354
357
|
*/
|
|
355
358
|
ProgramDateTimeIntervalSeconds?: number;
|
|
@@ -361,6 +364,11 @@ export type HlsManifestConfiguration = {
|
|
|
361
364
|
* <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
|
|
362
365
|
*/
|
|
363
366
|
StartTag?: StartTag;
|
|
367
|
+
/**
|
|
368
|
+
* <p>When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.
|
|
369
|
+
For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>
|
|
370
|
+
*/
|
|
371
|
+
UrlEncodeChildManifest?: boolean;
|
|
364
372
|
};
|
|
365
373
|
/**
|
|
366
374
|
* Type definition for `AWS::MediaPackageV2::OriginEndpoint.LowLatencyHlsManifestConfiguration`.
|
|
@@ -393,8 +401,7 @@ export type LowLatencyHlsManifestConfiguration = {
|
|
|
393
401
|
/**
|
|
394
402
|
* <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
|
|
395
403
|
EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
|
|
396
|
-
The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player
|
|
397
|
-
ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.</p>
|
|
404
|
+
The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.</p>
|
|
398
405
|
<p>Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.</p>
|
|
399
406
|
*/
|
|
400
407
|
ProgramDateTimeIntervalSeconds?: number;
|
|
@@ -406,6 +413,11 @@ export type LowLatencyHlsManifestConfiguration = {
|
|
|
406
413
|
* <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
|
|
407
414
|
*/
|
|
408
415
|
StartTag?: StartTag;
|
|
416
|
+
/**
|
|
417
|
+
* <p>When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.
|
|
418
|
+
For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>
|
|
419
|
+
*/
|
|
420
|
+
UrlEncodeChildManifest?: boolean;
|
|
409
421
|
};
|
|
410
422
|
/**
|
|
411
423
|
* Type definition for `AWS::MediaPackageV2::OriginEndpoint.PresetSpeke20Audio`.
|
|
@@ -5,6 +5,12 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html}
|
|
6
6
|
*/
|
|
7
7
|
export type Route53ResolverResolverRuleProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* The name server domain for queries to be delegated to if a query matches the delegation record.
|
|
10
|
+
* @minLength `1`
|
|
11
|
+
* @maxLength `256`
|
|
12
|
+
*/
|
|
13
|
+
DelegationRecord?: string;
|
|
8
14
|
/**
|
|
9
15
|
* DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
|
|
10
16
|
* @minLength `1`
|