@awboost/cfn-resource-types 0.1.197 → 0.1.199

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 (81) 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-AutoScaling-ScalingPolicy.d.ts +3 -0
  10. package/lib/AWS-Chatbot-CustomAction.d.ts +122 -0
  11. package/lib/AWS-Chatbot-CustomAction.js +12 -0
  12. package/lib/AWS-Chatbot-MicrosoftTeamsChannelConfiguration.d.ts +4 -0
  13. package/lib/AWS-Chatbot-SlackChannelConfiguration.d.ts +4 -0
  14. package/lib/AWS-CloudFront-CachePolicy.d.ts +105 -12
  15. package/lib/AWS-CloudFront-CachePolicy.js +7 -1
  16. package/lib/AWS-CloudFront-CloudFrontOriginAccessIdentity.d.ts +11 -2
  17. package/lib/AWS-CloudFront-CloudFrontOriginAccessIdentity.js +2 -1
  18. package/lib/AWS-CloudFront-ContinuousDeploymentPolicy.d.ts +52 -2
  19. package/lib/AWS-CloudFront-ContinuousDeploymentPolicy.js +4 -1
  20. package/lib/AWS-CloudFront-Distribution.d.ts +53 -11
  21. package/lib/AWS-CloudFront-Function.d.ts +42 -2
  22. package/lib/AWS-CloudFront-Function.js +5 -1
  23. package/lib/AWS-CloudFront-KeyGroup.d.ts +20 -2
  24. package/lib/AWS-CloudFront-KeyGroup.js +3 -1
  25. package/lib/AWS-CloudFront-KeyValueStore.d.ts +20 -2
  26. package/lib/AWS-CloudFront-KeyValueStore.js +2 -1
  27. package/lib/AWS-CloudFront-MonitoringSubscription.d.ts +18 -2
  28. package/lib/AWS-CloudFront-MonitoringSubscription.js +2 -1
  29. package/lib/AWS-CloudFront-OriginAccessControl.d.ts +29 -4
  30. package/lib/AWS-CloudFront-OriginAccessControl.js +4 -1
  31. package/lib/AWS-CloudFront-OriginRequestPolicy.d.ts +75 -8
  32. package/lib/AWS-CloudFront-OriginRequestPolicy.js +8 -1
  33. package/lib/AWS-CloudFront-PublicKey.d.ts +20 -2
  34. package/lib/AWS-CloudFront-PublicKey.js +2 -1
  35. package/lib/AWS-CloudFront-RealtimeLogConfig.d.ts +28 -4
  36. package/lib/AWS-CloudFront-RealtimeLogConfig.js +2 -1
  37. package/lib/AWS-CloudFront-ResponseHeadersPolicy.d.ts +213 -6
  38. package/lib/AWS-CloudFront-ResponseHeadersPolicy.js +5 -1
  39. package/lib/AWS-CloudTrail-Dashboard.d.ts +129 -0
  40. package/lib/AWS-CloudTrail-Dashboard.js +13 -0
  41. package/lib/AWS-Connect-EmailAddress.d.ts +79 -0
  42. package/lib/AWS-Connect-EmailAddress.js +12 -0
  43. package/lib/AWS-Connect-HoursOfOperation.d.ts +82 -0
  44. package/lib/AWS-CustomerProfiles-SegmentDefinition.d.ts +424 -0
  45. package/lib/AWS-CustomerProfiles-SegmentDefinition.js +13 -0
  46. package/lib/AWS-DynamoDB-Table.d.ts +9 -0
  47. package/lib/AWS-EC2-LaunchTemplate.d.ts +28 -0
  48. package/lib/AWS-EC2-VPCBlockPublicAccessExclusion.d.ts +62 -0
  49. package/lib/AWS-EC2-VPCBlockPublicAccessExclusion.js +12 -0
  50. package/lib/AWS-EC2-VPCBlockPublicAccessOptions.d.ts +31 -0
  51. package/lib/AWS-EC2-VPCBlockPublicAccessOptions.js +12 -0
  52. package/lib/AWS-ElasticLoadBalancingV2-Listener.d.ts +3 -3
  53. package/lib/AWS-ElasticLoadBalancingV2-ListenerRule.d.ts +1 -1
  54. package/lib/AWS-IVS-IngestConfiguration.d.ts +92 -0
  55. package/lib/AWS-IVS-IngestConfiguration.js +12 -0
  56. package/lib/AWS-IoTFleetWise-DecoderManifest.d.ts +63 -2
  57. package/lib/AWS-IoTFleetWise-StateTemplate.d.ts +75 -0
  58. package/lib/AWS-IoTFleetWise-StateTemplate.js +12 -0
  59. package/lib/AWS-IoTSiteWise-Portal.d.ts +25 -0
  60. package/lib/AWS-Lambda-EventSourceMapping.d.ts +19 -0
  61. package/lib/AWS-M2-Deployment.d.ts +48 -0
  62. package/lib/AWS-M2-Deployment.js +13 -0
  63. package/lib/AWS-OpenSearchServerless-SecurityConfig.d.ts +41 -1
  64. package/lib/AWS-RDS-GlobalCluster.d.ts +11 -0
  65. package/lib/AWS-ResourceGroups-TagSyncTask.d.ts +78 -0
  66. package/lib/AWS-ResourceGroups-TagSyncTask.js +13 -0
  67. package/lib/AWS-S3Express-DirectoryBucket.d.ts +54 -0
  68. package/lib/AWS-SageMaker-Cluster.d.ts +1 -0
  69. package/lib/AWS-SageMaker-Domain.d.ts +1 -1
  70. package/lib/AWS-SageMaker-InferenceComponent.d.ts +9 -3
  71. package/lib/AWS-SageMaker-ModelPackage.d.ts +1 -1
  72. package/lib/AWS-SageMaker-UserProfile.d.ts +1 -1
  73. package/lib/AWS-Synthetics-Canary.d.ts +4 -0
  74. package/lib/AWS-Wisdom-MessageTemplate.d.ts +668 -0
  75. package/lib/AWS-Wisdom-MessageTemplate.js +12 -0
  76. package/lib/AWS-Wisdom-MessageTemplateVersion.d.ts +45 -0
  77. package/lib/AWS-Wisdom-MessageTemplateVersion.js +13 -0
  78. package/lib/AWS-WorkSpacesWeb-DataProtectionSettings.d.ts +182 -0
  79. package/lib/AWS-WorkSpacesWeb-DataProtectionSettings.js +12 -0
  80. package/lib/AWS-WorkSpacesWeb-Portal.d.ts +6 -0
  81. package/package.json +1 -1
@@ -1,10 +1,19 @@
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::CachePolicy
4
+ * Resource type definition for `AWS::CloudFront::CachePolicy`.
5
+ * A cache policy.
6
+ When it's attached to a cache behavior, the cache policy determines the following:
7
+ + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
8
+ + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
9
+
10
+ The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.
5
11
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html}
6
12
  */
7
13
  export type CloudFrontCachePolicyProperties = {
14
+ /**
15
+ * The cache policy configuration.
16
+ */
8
17
  CachePolicyConfig: CachePolicyConfig;
9
18
  };
10
19
  /**
@@ -17,71 +26,155 @@ export type CloudFrontCachePolicyAttributes = {
17
26
  };
18
27
  /**
19
28
  * Type definition for `AWS::CloudFront::CachePolicy.CachePolicyConfig`.
29
+ * A cache policy configuration.
30
+ This configuration determines the following:
31
+ + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
32
+ + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
33
+
34
+ The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.
20
35
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html}
21
36
  */
22
37
  export type CachePolicyConfig = {
23
- Comment?: string;
24
38
  /**
25
- * @min `0`
39
+ * A comment to describe the cache policy. The comment cannot be longer than 128 characters.
26
40
  */
41
+ Comment?: string;
42
+ /**
43
+ * The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does *not* send ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.
44
+ The default value for this field is 86400 seconds (one day). If the value of ``MinTTL`` is more than 86400 seconds, then the default value for this field is the same as the value of ``MinTTL``.
45
+ * @min `0`
46
+ */
27
47
  DefaultTTL: number;
28
48
  /**
29
- * @min `0`
30
- */
49
+ * The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.
50
+ The default value for this field is 31536000 seconds (one year). If the value of ``MinTTL`` or ``DefaultTTL`` is more than 31536000 seconds, then the default value for this field is the same as the value of ``DefaultTTL``.
51
+ * @min `0`
52
+ */
31
53
  MaxTTL: number;
32
54
  /**
55
+ * The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.
33
56
  * @min `0`
34
57
  */
35
58
  MinTTL: number;
59
+ /**
60
+ * A unique name to identify the cache policy.
61
+ */
36
62
  Name: string;
63
+ /**
64
+ * The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
65
+ */
37
66
  ParametersInCacheKeyAndForwardedToOrigin: ParametersInCacheKeyAndForwardedToOrigin;
38
67
  };
39
68
  /**
40
69
  * Type definition for `AWS::CloudFront::CachePolicy.CookiesConfig`.
70
+ * An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
41
71
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html}
42
72
  */
43
73
  export type CookiesConfig = {
44
74
  /**
45
- * @pattern `^(none|whitelist|allExcept|all)$`
46
- */
75
+ * Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
76
+ + ``none`` – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any cookies that are listed in an ``OriginRequestPolicy`` *are* included in origin requests.
77
+ + ``whitelist`` – Only the cookies in viewer requests that are listed in the ``CookieNames`` type are included in the cache key and in requests that CloudFront sends to the origin.
78
+ + ``allExcept`` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, *except* for those that are listed in the ``CookieNames`` type, which are not included.
79
+ + ``all`` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
80
+ * @pattern `^(none|whitelist|allExcept|all)$`
81
+ */
47
82
  CookieBehavior: string;
83
+ /**
84
+ * Contains a list of cookie names.
85
+ */
48
86
  Cookies?: string[];
49
87
  };
50
88
  /**
51
89
  * Type definition for `AWS::CloudFront::CachePolicy.HeadersConfig`.
90
+ * An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
52
91
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-headersconfig.html}
53
92
  */
54
93
  export type HeadersConfig = {
55
94
  /**
56
- * @pattern `^(none|whitelist)$`
57
- */
95
+ * Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
96
+ + ``none`` – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any headers that are listed in an ``OriginRequestPolicy`` *are* included in origin requests.
97
+ + ``whitelist`` – Only the HTTP headers that are listed in the ``Headers`` type are included in the cache key and in requests that CloudFront sends to the origin.
98
+ * @pattern `^(none|whitelist)$`
99
+ */
58
100
  HeaderBehavior: string;
101
+ /**
102
+ * Contains a list of HTTP header names.
103
+ */
59
104
  Headers?: string[];
60
105
  };
61
106
  /**
62
107
  * Type definition for `AWS::CloudFront::CachePolicy.ParametersInCacheKeyAndForwardedToOrigin`.
108
+ * This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
109
+ The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.
63
110
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html}
64
111
  */
65
112
  export type ParametersInCacheKeyAndForwardedToOrigin = {
113
+ /**
114
+ * An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
115
+ */
66
116
  CookiesConfig: CookiesConfig;
117
+ /**
118
+ * A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
119
+ This field is related to the ``EnableAcceptEncodingGzip`` field. If one or both of these fields is ``true`` *and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following:
120
+ + Normalizes the value of the viewer's ``Accept-Encoding`` header
121
+ + Includes the normalized header in the cache key
122
+ + Includes the normalized header in the request to the origin, if a request is necessary
123
+
124
+ For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.
125
+ If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect.
126
+ If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header.
127
+ */
67
128
  EnableAcceptEncodingBrotli?: boolean;
129
+ /**
130
+ * A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
131
+ This field is related to the ``EnableAcceptEncodingBrotli`` field. If one or both of these fields is ``true`` *and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following:
132
+ + Normalizes the value of the viewer's ``Accept-Encoding`` header
133
+ + Includes the normalized header in the cache key
134
+ + Includes the normalized header in the request to the origin, if a request is necessary
135
+
136
+ For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.
137
+ If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect.
138
+ If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header.
139
+ */
68
140
  EnableAcceptEncodingGzip: boolean;
141
+ /**
142
+ * An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
143
+ */
69
144
  HeadersConfig: HeadersConfig;
145
+ /**
146
+ * An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
147
+ */
70
148
  QueryStringsConfig: QueryStringsConfig;
71
149
  };
72
150
  /**
73
151
  * Type definition for `AWS::CloudFront::CachePolicy.QueryStringsConfig`.
152
+ * An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
74
153
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html}
75
154
  */
76
155
  export type QueryStringsConfig = {
77
156
  /**
78
- * @pattern `^(none|whitelist|allExcept|all)$`
79
- */
157
+ * Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
158
+ + ``none`` – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any query strings that are listed in an ``OriginRequestPolicy`` *are* included in origin requests.
159
+ + ``whitelist`` – Only the query strings in viewer requests that are listed in the ``QueryStringNames`` type are included in the cache key and in requests that CloudFront sends to the origin.
160
+ + ``allExcept`` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, *except* those that are listed in the ``QueryStringNames`` type, which are not included.
161
+ + ``all`` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
162
+ * @pattern `^(none|whitelist|allExcept|all)$`
163
+ */
80
164
  QueryStringBehavior: string;
165
+ /**
166
+ * Contains a list of query string names.
167
+ */
81
168
  QueryStrings?: string[];
82
169
  };
83
170
  /**
84
- * Resource Type definition for AWS::CloudFront::CachePolicy
171
+ * Resource type definition for `AWS::CloudFront::CachePolicy`.
172
+ * A cache policy.
173
+ When it's attached to a cache behavior, the cache policy determines the following:
174
+ + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
175
+ + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
176
+
177
+ The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.
85
178
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html}
86
179
  */
87
180
  export declare class CloudFrontCachePolicy extends $Resource<"AWS::CloudFront::CachePolicy", CloudFrontCachePolicyProperties, CloudFrontCachePolicyAttributes> {
@@ -1,6 +1,12 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::CloudFront::CachePolicy
3
+ * Resource type definition for `AWS::CloudFront::CachePolicy`.
4
+ * A cache policy.
5
+ When it's attached to a cache behavior, the cache policy determines the following:
6
+ + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
7
+ + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
8
+
9
+ The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.
4
10
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html}
5
11
  */
6
12
  export class CloudFrontCachePolicy 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::CloudFrontOriginAccessIdentity
4
+ * Resource type definition for `AWS::CloudFront::CloudFrontOriginAccessIdentity`.
5
+ * The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html}
6
7
  */
7
8
  export type CloudFrontCloudFrontOriginAccessIdentityProperties = {
9
+ /**
10
+ * The current configuration information for the identity.
11
+ */
8
12
  CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfig;
9
13
  };
10
14
  /**
@@ -17,13 +21,18 @@ export type CloudFrontCloudFrontOriginAccessIdentityAttributes = {
17
21
  };
18
22
  /**
19
23
  * Type definition for `AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig`.
24
+ * Origin access identity configuration. Send a ``GET`` request to the ``/CloudFront API version/CloudFront/identity ID/config`` resource.
20
25
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html}
21
26
  */
22
27
  export type CloudFrontOriginAccessIdentityConfig = {
28
+ /**
29
+ * A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
30
+ */
23
31
  Comment: string;
24
32
  };
25
33
  /**
26
- * Resource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity
34
+ * Resource type definition for `AWS::CloudFront::CloudFrontOriginAccessIdentity`.
35
+ * The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.
27
36
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html}
28
37
  */
29
38
  export declare class CloudFrontCloudFrontOriginAccessIdentity extends $Resource<"AWS::CloudFront::CloudFrontOriginAccessIdentity", CloudFrontCloudFrontOriginAccessIdentityProperties, CloudFrontCloudFrontOriginAccessIdentityAttributes> {
@@ -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::CloudFrontOriginAccessIdentity
3
+ * Resource type definition for `AWS::CloudFront::CloudFrontOriginAccessIdentity`.
4
+ * The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html}
5
6
  */
6
7
  export class CloudFrontCloudFrontOriginAccessIdentity extends $Resource {
@@ -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::ContinuousDeploymentPolicy
4
+ * Resource type definition for `AWS::CloudFront::ContinuousDeploymentPolicy`.
5
+ * Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
6
+ After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
7
+ For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.
5
8
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html}
6
9
  */
7
10
  export type CloudFrontContinuousDeploymentPolicyProperties = {
11
+ /**
12
+ * Contains the configuration for a continuous deployment policy.
13
+ */
8
14
  ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfig;
9
15
  };
10
16
  /**
@@ -17,10 +23,17 @@ export type CloudFrontContinuousDeploymentPolicyAttributes = {
17
23
  };
18
24
  /**
19
25
  * Type definition for `AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig`.
26
+ * Contains the configuration for a continuous deployment policy.
20
27
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html}
21
28
  */
22
29
  export type ContinuousDeploymentPolicyConfig = {
30
+ /**
31
+ * A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is ``true``, this policy is enabled and in effect. When this value is ``false``, this policy is not enabled and has no effect.
32
+ */
23
33
  Enabled: boolean;
34
+ /**
35
+ * This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
36
+ */
24
37
  SingleHeaderPolicyConfig?: {
25
38
  /**
26
39
  * @minLength `1`
@@ -33,7 +46,13 @@ export type ContinuousDeploymentPolicyConfig = {
33
46
  */
34
47
  Value: string;
35
48
  };
49
+ /**
50
+ * This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
51
+ */
36
52
  SingleWeightPolicyConfig?: {
53
+ /**
54
+ * Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
55
+ */
37
56
  SessionStickinessConfig?: SessionStickinessConfig;
38
57
  /**
39
58
  * @min `0`
@@ -42,23 +61,33 @@ export type ContinuousDeploymentPolicyConfig = {
42
61
  Weight: number;
43
62
  };
44
63
  /**
64
+ * The CloudFront domain name of the staging distribution. For example: ``d111111abcdef8.cloudfront.net``.
45
65
  * @minLength `1`
46
66
  */
47
67
  StagingDistributionDnsNames: string[];
68
+ /**
69
+ * Contains the parameters for routing production traffic from your primary to staging distributions.
70
+ */
48
71
  TrafficConfig?: TrafficConfig;
72
+ /**
73
+ * The type of traffic configuration.
74
+ */
49
75
  Type?: "SingleWeight" | "SingleHeader";
50
76
  };
51
77
  /**
52
78
  * Type definition for `AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig`.
79
+ * Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
53
80
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html}
54
81
  */
55
82
  export type SessionStickinessConfig = {
56
83
  /**
84
+ * The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
57
85
  * @min `300`
58
86
  * @max `3600`
59
87
  */
60
88
  IdleTTL: number;
61
89
  /**
90
+ * The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
62
91
  * @min `300`
63
92
  * @max `3600`
64
93
  */
@@ -66,15 +95,18 @@ export type SessionStickinessConfig = {
66
95
  };
67
96
  /**
68
97
  * Type definition for `AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig`.
98
+ * Determines which HTTP requests are sent to the staging distribution.
69
99
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html}
70
100
  */
71
101
  export type SingleHeaderConfig = {
72
102
  /**
103
+ * The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix ``aws-cf-cd-``.
73
104
  * @minLength `1`
74
105
  * @maxLength `256`
75
106
  */
76
107
  Header: string;
77
108
  /**
109
+ * The request header value.
78
110
  * @minLength `1`
79
111
  * @maxLength `1783`
80
112
  */
@@ -82,11 +114,16 @@ export type SingleHeaderConfig = {
82
114
  };
83
115
  /**
84
116
  * Type definition for `AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig`.
117
+ * This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
85
118
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html}
86
119
  */
87
120
  export type SingleWeightConfig = {
121
+ /**
122
+ * Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
123
+ */
88
124
  SessionStickinessConfig?: SessionStickinessConfig;
89
125
  /**
126
+ * The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
90
127
  * @min `0`
91
128
  * @max `1`
92
129
  */
@@ -94,15 +131,28 @@ export type SingleWeightConfig = {
94
131
  };
95
132
  /**
96
133
  * Type definition for `AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig`.
134
+ * The traffic configuration of your continuous deployment.
97
135
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html}
98
136
  */
99
137
  export type TrafficConfig = {
138
+ /**
139
+ * Determines which HTTP requests are sent to the staging distribution.
140
+ */
100
141
  SingleHeaderConfig?: SingleHeaderConfig;
142
+ /**
143
+ * Contains the percentage of traffic to send to the staging distribution.
144
+ */
101
145
  SingleWeightConfig?: SingleWeightConfig;
146
+ /**
147
+ * The type of traffic configuration.
148
+ */
102
149
  Type: "SingleWeight" | "SingleHeader";
103
150
  };
104
151
  /**
105
- * Resource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy
152
+ * Resource type definition for `AWS::CloudFront::ContinuousDeploymentPolicy`.
153
+ * Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
154
+ After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
155
+ For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.
106
156
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html}
107
157
  */
108
158
  export declare class CloudFrontContinuousDeploymentPolicy extends $Resource<"AWS::CloudFront::ContinuousDeploymentPolicy", CloudFrontContinuousDeploymentPolicyProperties, CloudFrontContinuousDeploymentPolicyAttributes> {
@@ -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::ContinuousDeploymentPolicy
3
+ * Resource type definition for `AWS::CloudFront::ContinuousDeploymentPolicy`.
4
+ * Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
5
+ After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
6
+ For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.
4
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html}
5
8
  */
6
9
  export class CloudFrontContinuousDeploymentPolicy extends $Resource {
@@ -28,7 +28,7 @@ export type CloudFrontDistributionAttributes = {
28
28
  * A complex type that describes how CloudFront processes requests.
29
29
  You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
30
30
  For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.
31
- If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't include an empty ``CacheBehavior`` element because this is invalid.
31
+ If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't specify an empty individual ``CacheBehavior`` element, because this is invalid. For more information, see [CacheBehaviors](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html).
32
32
  To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element.
33
33
  To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
34
34
  For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.
@@ -298,7 +298,7 @@ export type DefaultCacheBehavior = {
298
298
  */
299
299
  ForwardedValues?: ForwardedValues;
300
300
  /**
301
- * A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.
301
+ * A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the ``LIVE`` stage to associate them with a cache behavior.
302
302
  */
303
303
  FunctionAssociations?: FunctionAssociation[];
304
304
  /**
@@ -368,6 +368,10 @@ export type DistributionConfig = {
368
368
  * A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
369
369
  */
370
370
  Aliases?: string[];
371
+ /**
372
+ * An alias for the CF distribution's domain name.
373
+ This property is legacy. We recommend that you use [Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases) instead.
374
+ */
371
375
  CNAMEs?: string[];
372
376
  /**
373
377
  * A complex type that contains zero or more ``CacheBehavior`` elements.
@@ -389,6 +393,10 @@ export type DistributionConfig = {
389
393
  For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.
390
394
  */
391
395
  CustomErrorResponses?: CustomErrorResponse[];
396
+ /**
397
+ * The user-defined HTTP server that serves as the origin for content that CF distributes.
398
+ This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
399
+ */
392
400
  CustomOrigin?: LegacyCustomOrigin;
393
401
  /**
394
402
  * A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.
@@ -408,7 +416,7 @@ export type DistributionConfig = {
408
416
  */
409
417
  Enabled: boolean;
410
418
  /**
411
- * (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.
419
+ * (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.
412
420
  For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
413
421
  For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).
414
422
  */
@@ -430,12 +438,14 @@ export type DistributionConfig = {
430
438
  */
431
439
  Logging?: Logging;
432
440
  /**
433
- * A complex type that contains information about origin groups for this distribution.
434
- */
441
+ * A complex type that contains information about origin groups for this distribution.
442
+ Specify a value for either the ``Origins`` or ``OriginGroups`` property.
443
+ */
435
444
  OriginGroups?: OriginGroups;
436
445
  /**
437
- * A complex type that contains information about origins for this distribution.
438
- */
446
+ * A complex type that contains information about origins for this distribution.
447
+ Specify a value for either the ``Origins`` or ``OriginGroups`` property.
448
+ */
439
449
  Origins?: Origin[];
440
450
  /**
441
451
  * The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.
@@ -447,6 +457,10 @@ export type DistributionConfig = {
447
457
  * A complex type that identifies ways in which you want to restrict distribution of your content.
448
458
  */
449
459
  Restrictions?: Restrictions;
460
+ /**
461
+ * The origin as an S3 bucket.
462
+ This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
463
+ */
450
464
  S3Origin?: LegacyS3Origin;
451
465
  /**
452
466
  * A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution.
@@ -457,7 +471,7 @@ export type DistributionConfig = {
457
471
  */
458
472
  ViewerCertificate?: ViewerCertificate;
459
473
  /**
460
- * A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``.
474
+ * A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``.
461
475
  WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).
462
476
  */
463
477
  WebACLId?: string;
@@ -566,21 +580,48 @@ export type LambdaFunctionAssociation = {
566
580
  };
567
581
  /**
568
582
  * Type definition for `AWS::CloudFront::Distribution.LegacyCustomOrigin`.
583
+ * A custom origin. A custom origin is any origin that is *not* an S3 bucket, with one exception. An S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.
584
+ This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
569
585
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html}
570
586
  */
571
587
  export type LegacyCustomOrigin = {
588
+ /**
589
+ * The domain name assigned to your CF distribution.
590
+ */
572
591
  DNSName: string;
592
+ /**
593
+ * The HTTP port that CF uses to connect to the origin. Specify the HTTP port that the origin listens on.
594
+ */
573
595
  HTTPPort?: number;
596
+ /**
597
+ * The HTTPS port that CF uses to connect to the origin. Specify the HTTPS port that the origin listens on.
598
+ */
574
599
  HTTPSPort?: number;
600
+ /**
601
+ * Specifies the protocol (HTTP or HTTPS) that CF uses to connect to the origin.
602
+ */
575
603
  OriginProtocolPolicy: string;
604
+ /**
605
+ * The minimum SSL/TLS protocol version that CF uses when communicating with your origin server over HTTPs.
606
+ For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Developer Guide*.
607
+ */
576
608
  OriginSSLProtocols: string[];
577
609
  };
578
610
  /**
579
611
  * Type definition for `AWS::CloudFront::Distribution.LegacyS3Origin`.
612
+ * The origin as an S3 bucket.
613
+ This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
580
614
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html}
581
615
  */
582
616
  export type LegacyS3Origin = {
617
+ /**
618
+ * The domain name assigned to your CF distribution.
619
+ */
583
620
  DNSName: string;
621
+ /**
622
+ * The CF origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an S3 through CF.
623
+ This property is legacy. We recommend that you use [OriginAccessControl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html) instead.
624
+ */
584
625
  OriginAccessIdentity?: string;
585
626
  };
586
627
  /**
@@ -792,9 +833,10 @@ export type Restrictions = {
792
833
  */
793
834
  export type S3OriginConfig = {
794
835
  /**
795
- * The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
796
- origin-access-identity/cloudfront/*ID-of-origin-access-identity*
797
- where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.
836
+ * If you're using origin access control (OAC) instead of origin access identity, specify an empty ``OriginAccessIdentity`` element. For more information, see [Restricting access to an](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
837
+ The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
838
+ ``origin-access-identity/cloudfront/ID-of-origin-access-identity``
839
+ The ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.
798
840
  If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.
799
841
  To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.
800
842
  To replace the origin access identity, update the distribution configuration and specify the new origin access identity.