@awboost/cfn-resource-types 0.1.197 → 0.1.198

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.
Files changed (69) hide show
  1. package/lib/AWS-ApiGateway-BasePathMappingV2.d.ts +43 -0
  2. package/lib/AWS-ApiGateway-BasePathMappingV2.js +12 -0
  3. package/lib/AWS-ApiGateway-DomainNameAccessAssociation.d.ts +51 -0
  4. package/lib/AWS-ApiGateway-DomainNameAccessAssociation.js +12 -0
  5. package/lib/AWS-ApiGateway-DomainNameV2.d.ts +50 -0
  6. package/lib/AWS-ApiGateway-DomainNameV2.js +12 -0
  7. package/lib/AWS-ApplicationAutoScaling-ScalingPolicy.d.ts +146 -0
  8. package/lib/AWS-AutoScaling-AutoScalingGroup.d.ts +17 -0
  9. package/lib/AWS-CloudFront-CachePolicy.d.ts +105 -12
  10. package/lib/AWS-CloudFront-CachePolicy.js +7 -1
  11. package/lib/AWS-CloudFront-CloudFrontOriginAccessIdentity.d.ts +11 -2
  12. package/lib/AWS-CloudFront-CloudFrontOriginAccessIdentity.js +2 -1
  13. package/lib/AWS-CloudFront-ContinuousDeploymentPolicy.d.ts +52 -2
  14. package/lib/AWS-CloudFront-ContinuousDeploymentPolicy.js +4 -1
  15. package/lib/AWS-CloudFront-Distribution.d.ts +53 -11
  16. package/lib/AWS-CloudFront-Function.d.ts +42 -2
  17. package/lib/AWS-CloudFront-Function.js +5 -1
  18. package/lib/AWS-CloudFront-KeyGroup.d.ts +20 -2
  19. package/lib/AWS-CloudFront-KeyGroup.js +3 -1
  20. package/lib/AWS-CloudFront-KeyValueStore.d.ts +20 -2
  21. package/lib/AWS-CloudFront-KeyValueStore.js +2 -1
  22. package/lib/AWS-CloudFront-MonitoringSubscription.d.ts +18 -2
  23. package/lib/AWS-CloudFront-MonitoringSubscription.js +2 -1
  24. package/lib/AWS-CloudFront-OriginAccessControl.d.ts +29 -4
  25. package/lib/AWS-CloudFront-OriginAccessControl.js +4 -1
  26. package/lib/AWS-CloudFront-OriginRequestPolicy.d.ts +75 -8
  27. package/lib/AWS-CloudFront-OriginRequestPolicy.js +8 -1
  28. package/lib/AWS-CloudFront-PublicKey.d.ts +20 -2
  29. package/lib/AWS-CloudFront-PublicKey.js +2 -1
  30. package/lib/AWS-CloudFront-RealtimeLogConfig.d.ts +28 -4
  31. package/lib/AWS-CloudFront-RealtimeLogConfig.js +2 -1
  32. package/lib/AWS-CloudFront-ResponseHeadersPolicy.d.ts +213 -6
  33. package/lib/AWS-CloudFront-ResponseHeadersPolicy.js +5 -1
  34. package/lib/AWS-CloudTrail-Dashboard.d.ts +129 -0
  35. package/lib/AWS-CloudTrail-Dashboard.js +13 -0
  36. package/lib/AWS-Connect-EmailAddress.d.ts +79 -0
  37. package/lib/AWS-Connect-EmailAddress.js +12 -0
  38. package/lib/AWS-Connect-HoursOfOperation.d.ts +82 -0
  39. package/lib/AWS-CustomerProfiles-SegmentDefinition.d.ts +424 -0
  40. package/lib/AWS-CustomerProfiles-SegmentDefinition.js +13 -0
  41. package/lib/AWS-DynamoDB-Table.d.ts +9 -0
  42. package/lib/AWS-EC2-LaunchTemplate.d.ts +28 -0
  43. package/lib/AWS-IVS-IngestConfiguration.d.ts +92 -0
  44. package/lib/AWS-IVS-IngestConfiguration.js +12 -0
  45. package/lib/AWS-IoTFleetWise-DecoderManifest.d.ts +63 -2
  46. package/lib/AWS-IoTFleetWise-StateTemplate.d.ts +75 -0
  47. package/lib/AWS-IoTFleetWise-StateTemplate.js +12 -0
  48. package/lib/AWS-IoTSiteWise-Portal.d.ts +25 -0
  49. package/lib/AWS-Lambda-EventSourceMapping.d.ts +19 -0
  50. package/lib/AWS-M2-Deployment.d.ts +48 -0
  51. package/lib/AWS-M2-Deployment.js +13 -0
  52. package/lib/AWS-OpenSearchServerless-SecurityConfig.d.ts +41 -1
  53. package/lib/AWS-RDS-GlobalCluster.d.ts +11 -0
  54. package/lib/AWS-ResourceGroups-TagSyncTask.d.ts +78 -0
  55. package/lib/AWS-ResourceGroups-TagSyncTask.js +13 -0
  56. package/lib/AWS-S3Express-DirectoryBucket.d.ts +54 -0
  57. package/lib/AWS-SageMaker-Cluster.d.ts +1 -0
  58. package/lib/AWS-SageMaker-Domain.d.ts +1 -1
  59. package/lib/AWS-SageMaker-ModelPackage.d.ts +1 -1
  60. package/lib/AWS-SageMaker-UserProfile.d.ts +1 -1
  61. package/lib/AWS-Synthetics-Canary.d.ts +4 -0
  62. package/lib/AWS-Wisdom-MessageTemplate.d.ts +668 -0
  63. package/lib/AWS-Wisdom-MessageTemplate.js +12 -0
  64. package/lib/AWS-Wisdom-MessageTemplateVersion.d.ts +45 -0
  65. package/lib/AWS-Wisdom-MessageTemplateVersion.js +13 -0
  66. package/lib/AWS-WorkSpacesWeb-DataProtectionSettings.d.ts +182 -0
  67. package/lib/AWS-WorkSpacesWeb-DataProtectionSettings.js +12 -0
  68. package/lib/AWS-WorkSpacesWeb-Portal.d.ts +6 -0
  69. package/package.json +1 -1
@@ -1,10 +1,16 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::CloudFront::OriginAccessControl
4
+ * Resource type definition for `AWS::CloudFront::OriginAccessControl`.
5
+ * Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
6
+ This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
7
+ For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
5
8
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html}
6
9
  */
7
10
  export type CloudFrontOriginAccessControlProperties = {
11
+ /**
12
+ * The origin access control.
13
+ */
8
14
  OriginAccessControlConfig: OriginAccessControlConfig;
9
15
  };
10
16
  /**
@@ -16,26 +22,45 @@ export type CloudFrontOriginAccessControlAttributes = {
16
22
  };
17
23
  /**
18
24
  * Type definition for `AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig`.
25
+ * Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
26
+ This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
27
+ For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
19
28
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html}
20
29
  */
21
30
  export type OriginAccessControlConfig = {
31
+ /**
32
+ * A description of the origin access control.
33
+ */
22
34
  Description?: string;
35
+ /**
36
+ * A name to identify the origin access control. You can specify up to 64 characters.
37
+ */
23
38
  Name: string;
24
39
  /**
40
+ * The type of origin that this origin access control is for.
25
41
  * @pattern `^(s3|mediastore|lambda|mediapackagev2)$`
26
42
  */
27
43
  OriginAccessControlOriginType: string;
28
44
  /**
29
- * @pattern `^(never|no-override|always)$`
30
- */
45
+ * Specifies which requests CloudFront signs (adds authentication information to). Specify ``always`` for the most common use case. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*.
46
+ This field can have one of the following values:
47
+ + ``always`` – CloudFront signs all origin requests, overwriting the ``Authorization`` header from the viewer request if one exists.
48
+ + ``never`` – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
49
+ + ``no-override`` – If the viewer request doesn't contain the ``Authorization`` header, then CloudFront signs the origin request. If the viewer request contains the ``Authorization`` header, then CloudFront doesn't sign the origin request and instead passes along the ``Authorization`` header from the viewer request. *WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.*
50
+ * @pattern `^(never|no-override|always)$`
51
+ */
31
52
  SigningBehavior: string;
32
53
  /**
54
+ * The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is ``sigv4``.
33
55
  * @pattern `^(sigv4)$`
34
56
  */
35
57
  SigningProtocol: string;
36
58
  };
37
59
  /**
38
- * Resource Type definition for AWS::CloudFront::OriginAccessControl
60
+ * Resource type definition for `AWS::CloudFront::OriginAccessControl`.
61
+ * Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
62
+ This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
63
+ For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
39
64
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html}
40
65
  */
41
66
  export declare class CloudFrontOriginAccessControl extends $Resource<"AWS::CloudFront::OriginAccessControl", CloudFrontOriginAccessControlProperties, CloudFrontOriginAccessControlAttributes> {
@@ -1,6 +1,9 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::CloudFront::OriginAccessControl
3
+ * Resource type definition for `AWS::CloudFront::OriginAccessControl`.
4
+ * Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
5
+ This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
6
+ For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
4
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html}
5
8
  */
6
9
  export class CloudFrontOriginAccessControl extends $Resource {
@@ -1,10 +1,20 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::CloudFront::OriginRequestPolicy
4
+ * Resource type definition for `AWS::CloudFront::OriginRequestPolicy`.
5
+ * An origin request policy.
6
+ When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
7
+ + The request body and the URL path (without the domain name) from the viewer request.
8
+ + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``.
9
+ + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
10
+
11
+ CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``.
5
12
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html}
6
13
  */
7
14
  export type CloudFrontOriginRequestPolicyProperties = {
15
+ /**
16
+ * The origin request policy configuration.
17
+ */
8
18
  OriginRequestPolicyConfig: OriginRequestPolicyConfig;
9
19
  };
10
20
  /**
@@ -17,50 +27,107 @@ export type CloudFrontOriginRequestPolicyAttributes = {
17
27
  };
18
28
  /**
19
29
  * Type definition for `AWS::CloudFront::OriginRequestPolicy.CookiesConfig`.
30
+ * An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.
20
31
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html}
21
32
  */
22
33
  export type CookiesConfig = {
23
34
  /**
24
- * @pattern `^(none|whitelist|all|allExcept)$`
25
- */
35
+ * Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
36
+ + ``none`` – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any cookies that are listed in a ``CachePolicy`` *are* included in origin requests.
37
+ + ``whitelist`` – Only the cookies in viewer requests that are listed in the ``CookieNames`` type are included in requests that CloudFront sends to the origin.
38
+ + ``all`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
39
+ + ``allExcept`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``CookieNames`` type, which are not included.
40
+ * @pattern `^(none|whitelist|all|allExcept)$`
41
+ */
26
42
  CookieBehavior: string;
43
+ /**
44
+ * Contains a list of cookie names.
45
+ */
27
46
  Cookies?: string[];
28
47
  };
29
48
  /**
30
49
  * Type definition for `AWS::CloudFront::OriginRequestPolicy.HeadersConfig`.
50
+ * An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.
31
51
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-headersconfig.html}
32
52
  */
33
53
  export type HeadersConfig = {
34
54
  /**
35
- * @pattern `^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$`
36
- */
55
+ * Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
56
+ + ``none`` – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any headers that are listed in a ``CachePolicy`` *are* included in origin requests.
57
+ + ``whitelist`` – Only the HTTP headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin.
58
+ + ``allViewer`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
59
+ + ``allViewerAndWhitelistCloudFront`` – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.
60
+ + ``allExcept`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``Headers`` type, which are not included.
61
+ * @pattern `^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$`
62
+ */
37
63
  HeaderBehavior: string;
64
+ /**
65
+ * Contains a list of HTTP header names.
66
+ */
38
67
  Headers?: string[];
39
68
  };
40
69
  /**
41
70
  * Type definition for `AWS::CloudFront::OriginRequestPolicy.OriginRequestPolicyConfig`.
71
+ * An origin request policy configuration.
72
+ This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
73
+ + The request body and the URL path (without the domain name) from the viewer request.
74
+ + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``.
75
+ + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
76
+
77
+ CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``.
42
78
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html}
43
79
  */
44
80
  export type OriginRequestPolicyConfig = {
81
+ /**
82
+ * A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
83
+ */
45
84
  Comment?: string;
85
+ /**
86
+ * The cookies from viewer requests to include in origin requests.
87
+ */
46
88
  CookiesConfig: CookiesConfig;
89
+ /**
90
+ * The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
91
+ */
47
92
  HeadersConfig: HeadersConfig;
93
+ /**
94
+ * A unique name to identify the origin request policy.
95
+ */
48
96
  Name: string;
97
+ /**
98
+ * The URL query strings from viewer requests to include in origin requests.
99
+ */
49
100
  QueryStringsConfig: QueryStringsConfig;
50
101
  };
51
102
  /**
52
103
  * Type definition for `AWS::CloudFront::OriginRequestPolicy.QueryStringsConfig`.
104
+ * An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.
53
105
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-querystringsconfig.html}
54
106
  */
55
107
  export type QueryStringsConfig = {
56
108
  /**
57
- * @pattern `^(none|whitelist|all|allExcept)$`
58
- */
109
+ * Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
110
+ + ``none`` – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any query strings that are listed in a ``CachePolicy`` *are* included in origin requests.
111
+ + ``whitelist`` – Only the query strings in viewer requests that are listed in the ``QueryStringNames`` type are included in requests that CloudFront sends to the origin.
112
+ + ``all`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin.
113
+ + ``allExcept`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``QueryStringNames`` type, which are not included.
114
+ * @pattern `^(none|whitelist|all|allExcept)$`
115
+ */
59
116
  QueryStringBehavior: string;
117
+ /**
118
+ * Contains a list of query string names.
119
+ */
60
120
  QueryStrings?: string[];
61
121
  };
62
122
  /**
63
- * Resource Type definition for AWS::CloudFront::OriginRequestPolicy
123
+ * Resource type definition for `AWS::CloudFront::OriginRequestPolicy`.
124
+ * An origin request policy.
125
+ When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
126
+ + The request body and the URL path (without the domain name) from the viewer request.
127
+ + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``.
128
+ + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
129
+
130
+ CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``.
64
131
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html}
65
132
  */
66
133
  export declare class CloudFrontOriginRequestPolicy extends $Resource<"AWS::CloudFront::OriginRequestPolicy", CloudFrontOriginRequestPolicyProperties, CloudFrontOriginRequestPolicyAttributes> {
@@ -1,6 +1,13 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::CloudFront::OriginRequestPolicy
3
+ * Resource type definition for `AWS::CloudFront::OriginRequestPolicy`.
4
+ * An origin request policy.
5
+ When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
6
+ + The request body and the URL path (without the domain name) from the viewer request.
7
+ + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``.
8
+ + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
9
+
10
+ CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``.
4
11
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html}
5
12
  */
6
13
  export class CloudFrontOriginRequestPolicy extends $Resource {
@@ -1,10 +1,14 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::CloudFront::PublicKey
4
+ * Resource type definition for `AWS::CloudFront::PublicKey`.
5
+ * A public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html}
6
7
  */
7
8
  export type CloudFrontPublicKeyProperties = {
9
+ /**
10
+ * Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
11
+ */
8
12
  PublicKeyConfig: PublicKeyConfig;
9
13
  };
10
14
  /**
@@ -17,16 +21,30 @@ export type CloudFrontPublicKeyAttributes = {
17
21
  };
18
22
  /**
19
23
  * Type definition for `AWS::CloudFront::PublicKey.PublicKeyConfig`.
24
+ * Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
20
25
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html}
21
26
  */
22
27
  export type PublicKeyConfig = {
28
+ /**
29
+ * A string included in the request to help make sure that the request can't be replayed.
30
+ */
23
31
  CallerReference: string;
32
+ /**
33
+ * A comment to describe the public key. The comment cannot be longer than 128 characters.
34
+ */
24
35
  Comment?: string;
36
+ /**
37
+ * The public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
38
+ */
25
39
  EncodedKey: string;
40
+ /**
41
+ * A name to help identify the public key.
42
+ */
26
43
  Name: string;
27
44
  };
28
45
  /**
29
- * Resource Type definition for AWS::CloudFront::PublicKey
46
+ * Resource type definition for `AWS::CloudFront::PublicKey`.
47
+ * A public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
30
48
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html}
31
49
  */
32
50
  export declare class CloudFrontPublicKey extends $Resource<"AWS::CloudFront::PublicKey", CloudFrontPublicKeyProperties, CloudFrontPublicKeyAttributes> {
@@ -1,6 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::CloudFront::PublicKey
3
+ * Resource type definition for `AWS::CloudFront::PublicKey`.
4
+ * A public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html}
5
6
  */
6
7
  export class CloudFrontPublicKey extends $Resource {
@@ -1,20 +1,28 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::CloudFront::RealtimeLogConfig
4
+ * Resource type definition for `AWS::CloudFront::RealtimeLogConfig`.
5
+ * A real-time log configuration.
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html}
6
7
  */
7
8
  export type CloudFrontRealtimeLogConfigProperties = {
8
9
  /**
10
+ * Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
9
11
  * @minLength `1`
10
12
  */
11
13
  EndPoints: EndPoint[];
12
14
  /**
13
- * @minLength `1`
14
- */
15
+ * A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
16
+ For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*.
17
+ * @minLength `1`
18
+ */
15
19
  Fields: string[];
20
+ /**
21
+ * The unique name of this real-time log configuration.
22
+ */
16
23
  Name: string;
17
24
  /**
25
+ * The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
18
26
  * @min `1`
19
27
  * @max `100`
20
28
  */
@@ -29,22 +37,38 @@ export type CloudFrontRealtimeLogConfigAttributes = {
29
37
  };
30
38
  /**
31
39
  * Type definition for `AWS::CloudFront::RealtimeLogConfig.EndPoint`.
40
+ * Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
32
41
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html}
33
42
  */
34
43
  export type EndPoint = {
44
+ /**
45
+ * Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
46
+ */
35
47
  KinesisStreamConfig: KinesisStreamConfig;
48
+ /**
49
+ * The type of data stream where you are sending real-time log data. The only valid value is ``Kinesis``.
50
+ */
36
51
  StreamType: string;
37
52
  };
38
53
  /**
39
54
  * Type definition for `AWS::CloudFront::RealtimeLogConfig.KinesisStreamConfig`.
55
+ * Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
40
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html}
41
57
  */
42
58
  export type KinesisStreamConfig = {
59
+ /**
60
+ * The Amazon Resource Name (ARN) of an IAMlong (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
61
+ For more information the IAM role, see [Real-time log configuration IAM role](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) in the *Amazon CloudFront Developer Guide*.
62
+ */
43
63
  RoleArn: string;
64
+ /**
65
+ * The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
66
+ */
44
67
  StreamArn: string;
45
68
  };
46
69
  /**
47
- * Resource Type definition for AWS::CloudFront::RealtimeLogConfig
70
+ * Resource type definition for `AWS::CloudFront::RealtimeLogConfig`.
71
+ * A real-time log configuration.
48
72
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html}
49
73
  */
50
74
  export declare class CloudFrontRealtimeLogConfig extends $Resource<"AWS::CloudFront::RealtimeLogConfig", CloudFrontRealtimeLogConfigProperties, CloudFrontRealtimeLogConfigAttributes> {
@@ -1,6 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::CloudFront::RealtimeLogConfig
3
+ * Resource type definition for `AWS::CloudFront::RealtimeLogConfig`.
4
+ * A real-time log configuration.
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html}
5
6
  */
6
7
  export class CloudFrontRealtimeLogConfig extends $Resource {