@aws-sdk/client-cloudfront 3.804.0 → 3.808.0
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.
- package/README.md +1 -6
- package/dist-cjs/runtimeConfig.js +6 -6
- package/dist-es/runtimeConfig.js +6 -6
- package/dist-types/CloudFront.d.ts +1 -5
- package/dist-types/CloudFrontClient.d.ts +1 -5
- package/dist-types/commands/AssociateAliasCommand.d.ts +1 -11
- package/dist-types/commands/AssociateDistributionTenantWebACLCommand.d.ts +1 -2
- package/dist-types/commands/AssociateDistributionWebACLCommand.d.ts +1 -2
- package/dist-types/commands/CopyDistributionCommand.d.ts +26 -90
- package/dist-types/commands/CreateAnycastIpListCommand.d.ts +1 -2
- package/dist-types/commands/CreateCachePolicyCommand.d.ts +7 -39
- package/dist-types/commands/CreateCloudFrontOriginAccessIdentityCommand.d.ts +5 -16
- package/dist-types/commands/CreateConnectionGroupCommand.d.ts +1 -2
- package/dist-types/commands/CreateContinuousDeploymentPolicyCommand.d.ts +3 -13
- package/dist-types/commands/CreateDistributionCommand.d.ts +27 -69
- package/dist-types/commands/CreateDistributionTenantCommand.d.ts +1 -2
- package/dist-types/commands/CreateDistributionWithTagsCommand.d.ts +28 -83
- package/dist-types/commands/CreateFieldLevelEncryptionConfigCommand.d.ts +4 -8
- package/dist-types/commands/CreateFieldLevelEncryptionProfileCommand.d.ts +3 -6
- package/dist-types/commands/CreateFunctionCommand.d.ts +4 -19
- package/dist-types/commands/CreateInvalidationCommand.d.ts +3 -6
- package/dist-types/commands/CreateInvalidationForDistributionTenantCommand.d.ts +3 -6
- package/dist-types/commands/CreateKeyGroupCommand.d.ts +4 -17
- package/dist-types/commands/CreateKeyValueStoreCommand.d.ts +1 -2
- package/dist-types/commands/CreateMonitoringSubscriptionCommand.d.ts +1 -4
- package/dist-types/commands/CreateOriginAccessControlCommand.d.ts +2 -11
- package/dist-types/commands/CreateOriginRequestPolicyCommand.d.ts +7 -44
- package/dist-types/commands/CreatePublicKeyCommand.d.ts +1 -2
- package/dist-types/commands/CreateRealtimeLogConfigCommand.d.ts +3 -11
- package/dist-types/commands/CreateResponseHeadersPolicyCommand.d.ts +7 -32
- package/dist-types/commands/CreateStreamingDistributionCommand.d.ts +5 -11
- package/dist-types/commands/CreateStreamingDistributionWithTagsCommand.d.ts +5 -11
- package/dist-types/commands/CreateVpcOriginCommand.d.ts +2 -4
- package/dist-types/commands/DeleteAnycastIpListCommand.d.ts +1 -2
- package/dist-types/commands/DeleteCachePolicyCommand.d.ts +3 -11
- package/dist-types/commands/DeleteCloudFrontOriginAccessIdentityCommand.d.ts +1 -2
- package/dist-types/commands/DeleteConnectionGroupCommand.d.ts +1 -2
- package/dist-types/commands/DeleteContinuousDeploymentPolicyCommand.d.ts +3 -8
- package/dist-types/commands/DeleteDistributionCommand.d.ts +2 -4
- package/dist-types/commands/DeleteDistributionTenantCommand.d.ts +2 -4
- package/dist-types/commands/DeleteFieldLevelEncryptionConfigCommand.d.ts +1 -2
- package/dist-types/commands/DeleteFieldLevelEncryptionProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeleteFunctionCommand.d.ts +3 -11
- package/dist-types/commands/DeleteKeyGroupCommand.d.ts +2 -9
- package/dist-types/commands/DeleteKeyValueStoreCommand.d.ts +1 -2
- package/dist-types/commands/DeleteOriginAccessControlCommand.d.ts +3 -8
- package/dist-types/commands/DeleteOriginRequestPolicyCommand.d.ts +3 -11
- package/dist-types/commands/DeletePublicKeyCommand.d.ts +1 -2
- package/dist-types/commands/DeleteRealtimeLogConfigCommand.d.ts +2 -9
- package/dist-types/commands/DeleteResponseHeadersPolicyCommand.d.ts +3 -11
- package/dist-types/commands/DeleteStreamingDistributionCommand.d.ts +3 -53
- package/dist-types/commands/DeleteVpcOriginCommand.d.ts +1 -2
- package/dist-types/commands/DescribeFunctionCommand.d.ts +1 -5
- package/dist-types/commands/DisassociateDistributionTenantWebACLCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateDistributionWebACLCommand.d.ts +1 -2
- package/dist-types/commands/GetCachePolicyCommand.d.ts +1 -14
- package/dist-types/commands/GetCachePolicyConfigCommand.d.ts +1 -6
- package/dist-types/commands/GetContinuousDeploymentPolicyCommand.d.ts +1 -2
- package/dist-types/commands/GetFunctionCommand.d.ts +1 -4
- package/dist-types/commands/GetKeyGroupCommand.d.ts +1 -7
- package/dist-types/commands/GetKeyGroupConfigCommand.d.ts +1 -6
- package/dist-types/commands/GetMonitoringSubscriptionCommand.d.ts +1 -2
- package/dist-types/commands/GetOriginRequestPolicyCommand.d.ts +1 -15
- package/dist-types/commands/GetOriginRequestPolicyConfigCommand.d.ts +1 -7
- package/dist-types/commands/GetRealtimeLogConfigCommand.d.ts +1 -4
- package/dist-types/commands/GetResponseHeadersPolicyCommand.d.ts +1 -8
- package/dist-types/commands/GetResponseHeadersPolicyConfigCommand.d.ts +1 -7
- package/dist-types/commands/GetStreamingDistributionCommand.d.ts +1 -2
- package/dist-types/commands/ListCachePoliciesCommand.d.ts +1 -8
- package/dist-types/commands/ListConflictingAliasesCommand.d.ts +1 -23
- package/dist-types/commands/ListContinuousDeploymentPoliciesCommand.d.ts +1 -6
- package/dist-types/commands/ListDistributionTenantsByCustomizationCommand.d.ts +1 -2
- package/dist-types/commands/ListDistributionsByCachePolicyIdCommand.d.ts +1 -7
- package/dist-types/commands/ListDistributionsByKeyGroupCommand.d.ts +1 -7
- package/dist-types/commands/ListDistributionsByOriginRequestPolicyIdCommand.d.ts +1 -7
- package/dist-types/commands/ListDistributionsByRealtimeLogConfigCommand.d.ts +1 -10
- package/dist-types/commands/ListDistributionsByResponseHeadersPolicyIdCommand.d.ts +1 -7
- package/dist-types/commands/ListDistributionsByWebACLIdCommand.d.ts +1 -5
- package/dist-types/commands/ListDomainConflictsCommand.d.ts +1 -2
- package/dist-types/commands/ListFieldLevelEncryptionConfigsCommand.d.ts +1 -2
- package/dist-types/commands/ListFieldLevelEncryptionProfilesCommand.d.ts +1 -2
- package/dist-types/commands/ListFunctionsCommand.d.ts +1 -8
- package/dist-types/commands/ListKeyGroupsCommand.d.ts +1 -6
- package/dist-types/commands/ListOriginAccessControlsCommand.d.ts +1 -11
- package/dist-types/commands/ListOriginRequestPoliciesCommand.d.ts +1 -8
- package/dist-types/commands/ListRealtimeLogConfigsCommand.d.ts +1 -6
- package/dist-types/commands/ListResponseHeadersPoliciesCommand.d.ts +1 -8
- package/dist-types/commands/PublishFunctionCommand.d.ts +2 -12
- package/dist-types/commands/TestFunctionCommand.d.ts +1 -10
- package/dist-types/commands/UpdateCachePolicyCommand.d.ts +7 -33
- package/dist-types/commands/UpdateCloudFrontOriginAccessIdentityCommand.d.ts +3 -6
- package/dist-types/commands/UpdateConnectionGroupCommand.d.ts +2 -4
- package/dist-types/commands/UpdateContinuousDeploymentPolicyCommand.d.ts +3 -26
- package/dist-types/commands/UpdateDistributionCommand.d.ts +26 -99
- package/dist-types/commands/UpdateDistributionTenantCommand.d.ts +2 -4
- package/dist-types/commands/UpdateDistributionWithStagingConfigCommand.d.ts +23 -82
- package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateFieldLevelEncryptionConfigCommand.d.ts +4 -8
- package/dist-types/commands/UpdateFieldLevelEncryptionProfileCommand.d.ts +4 -8
- package/dist-types/commands/UpdateFunctionCommand.d.ts +3 -10
- package/dist-types/commands/UpdateKeyGroupCommand.d.ts +4 -25
- package/dist-types/commands/UpdateKeyValueStoreCommand.d.ts +1 -2
- package/dist-types/commands/UpdateOriginAccessControlCommand.d.ts +1 -2
- package/dist-types/commands/UpdateOriginRequestPolicyCommand.d.ts +7 -35
- package/dist-types/commands/UpdatePublicKeyCommand.d.ts +2 -4
- package/dist-types/commands/UpdateRealtimeLogConfigCommand.d.ts +1 -21
- package/dist-types/commands/UpdateResponseHeadersPolicyCommand.d.ts +7 -38
- package/dist-types/commands/UpdateStreamingDistributionCommand.d.ts +3 -6
- package/dist-types/commands/UpdateVpcOriginCommand.d.ts +3 -6
- package/dist-types/index.d.ts +1 -5
- package/dist-types/models/models_0.d.ts +324 -2005
- package/dist-types/models/models_1.d.ts +297 -1243
- package/dist-types/models/models_2.d.ts +45 -119
- package/package.json +15 -15
|
@@ -48,8 +48,7 @@ export interface KeyPairIds {
|
|
|
48
48
|
Items?: string[] | undefined;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* <p>A list of identifiers for the public keys that CloudFront can use to verify the signatures
|
|
52
|
-
* of signed URLs and signed cookies.</p>
|
|
51
|
+
* <p>A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
53
52
|
* @public
|
|
54
53
|
*/
|
|
55
54
|
export interface KGKeyPairIds {
|
|
@@ -65,15 +64,12 @@ export interface KGKeyPairIds {
|
|
|
65
64
|
KeyPairIds?: KeyPairIds | undefined;
|
|
66
65
|
}
|
|
67
66
|
/**
|
|
68
|
-
* <p>A list of key groups, and the public keys in each key group, that CloudFront can use to
|
|
69
|
-
* verify the signatures of signed URLs and signed cookies.</p>
|
|
67
|
+
* <p>A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
70
68
|
* @public
|
|
71
69
|
*/
|
|
72
70
|
export interface ActiveTrustedKeyGroups {
|
|
73
71
|
/**
|
|
74
|
-
* <p>This field is <code>true</code> if any of the key groups have public keys that CloudFront
|
|
75
|
-
* can use to verify the signatures of signed URLs and signed cookies. If not, this field
|
|
76
|
-
* is <code>false</code>.</p>
|
|
72
|
+
* <p>This field is <code>true</code> if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is <code>false</code>.</p>
|
|
77
73
|
* @public
|
|
78
74
|
*/
|
|
79
75
|
Enabled: boolean | undefined;
|
|
@@ -83,23 +79,18 @@ export interface ActiveTrustedKeyGroups {
|
|
|
83
79
|
*/
|
|
84
80
|
Quantity: number | undefined;
|
|
85
81
|
/**
|
|
86
|
-
* <p>A list of key groups, including the identifiers of the public keys in each key group
|
|
87
|
-
* that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
82
|
+
* <p>A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
88
83
|
* @public
|
|
89
84
|
*/
|
|
90
85
|
Items?: KGKeyPairIds[] | undefined;
|
|
91
86
|
}
|
|
92
87
|
/**
|
|
93
|
-
* <p>A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can
|
|
94
|
-
* use to verify the signatures of signed URLs and signed cookies.</p>
|
|
88
|
+
* <p>A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
95
89
|
* @public
|
|
96
90
|
*/
|
|
97
91
|
export interface Signer {
|
|
98
92
|
/**
|
|
99
|
-
* <p>An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to
|
|
100
|
-
* verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns
|
|
101
|
-
* the key pairs is the same account that owns the CloudFront distribution, the value of this
|
|
102
|
-
* field is <code>self</code>.</p>
|
|
93
|
+
* <p>An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is <code>self</code>.</p>
|
|
103
94
|
* @public
|
|
104
95
|
*/
|
|
105
96
|
AwsAccountNumber?: string | undefined;
|
|
@@ -110,14 +101,12 @@ export interface Signer {
|
|
|
110
101
|
KeyPairIds?: KeyPairIds | undefined;
|
|
111
102
|
}
|
|
112
103
|
/**
|
|
113
|
-
* <p>A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can
|
|
114
|
-
* use to verify the signatures of signed URLs and signed cookies.</p>
|
|
104
|
+
* <p>A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
115
105
|
* @public
|
|
116
106
|
*/
|
|
117
107
|
export interface ActiveTrustedSigners {
|
|
118
108
|
/**
|
|
119
|
-
* <p>This field is <code>true</code> if any of the Amazon Web Services accounts in the list are configured as
|
|
120
|
-
* trusted signers. If not, this field is <code>false</code>.</p>
|
|
109
|
+
* <p>This field is <code>true</code> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <code>false</code>.</p>
|
|
121
110
|
* @public
|
|
122
111
|
*/
|
|
123
112
|
Enabled: boolean | undefined;
|
|
@@ -127,27 +116,23 @@ export interface ActiveTrustedSigners {
|
|
|
127
116
|
*/
|
|
128
117
|
Quantity: number | undefined;
|
|
129
118
|
/**
|
|
130
|
-
* <p>A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account
|
|
131
|
-
* that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
119
|
+
* <p>A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
132
120
|
* @public
|
|
133
121
|
*/
|
|
134
122
|
Items?: Signer[] | undefined;
|
|
135
123
|
}
|
|
136
124
|
/**
|
|
137
|
-
* <p>A complex type that contains information about CNAMEs (alternate domain names), if
|
|
138
|
-
* any, for this distribution.</p>
|
|
125
|
+
* <p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>
|
|
139
126
|
* @public
|
|
140
127
|
*/
|
|
141
128
|
export interface Aliases {
|
|
142
129
|
/**
|
|
143
|
-
* <p>The number of CNAME aliases, if any, that you want to associate with this
|
|
144
|
-
* distribution.</p>
|
|
130
|
+
* <p>The number of CNAME aliases, if any, that you want to associate with this distribution.</p>
|
|
145
131
|
* @public
|
|
146
132
|
*/
|
|
147
133
|
Quantity: number | undefined;
|
|
148
134
|
/**
|
|
149
|
-
* <p>A complex type that contains the CNAME aliases, if any, that you want to associate
|
|
150
|
-
* with this distribution.</p>
|
|
135
|
+
* <p>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</p>
|
|
151
136
|
* @public
|
|
152
137
|
*/
|
|
153
138
|
Items?: string[] | undefined;
|
|
@@ -166,13 +151,7 @@ export declare const ICPRecordalStatus: {
|
|
|
166
151
|
*/
|
|
167
152
|
export type ICPRecordalStatus = (typeof ICPRecordalStatus)[keyof typeof ICPRecordalStatus];
|
|
168
153
|
/**
|
|
169
|
-
* <p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)
|
|
170
|
-
* recordal if they want to serve content publicly on an alternate domain name, also known
|
|
171
|
-
* as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal
|
|
172
|
-
* status for CNAMEs associated with distributions. The status is returned in the CloudFront
|
|
173
|
-
* response; you can't configure it yourself.</p>
|
|
174
|
-
* <p>For more information about ICP recordals, see <a href="https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services
|
|
175
|
-
* services in China</i>.</p>
|
|
154
|
+
* <p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.</p> <p>For more information about ICP recordals, see <a href="https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>
|
|
176
155
|
* @public
|
|
177
156
|
*/
|
|
178
157
|
export interface AliasICPRecordal {
|
|
@@ -182,32 +161,7 @@ export interface AliasICPRecordal {
|
|
|
182
161
|
*/
|
|
183
162
|
CNAME?: string | undefined;
|
|
184
163
|
/**
|
|
185
|
-
* <p>The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus
|
|
186
|
-
* is set to APPROVED for all CNAMEs (aliases) in Amazon Web Services Regions outside of China.</p>
|
|
187
|
-
* <p>The status values returned are the following:</p>
|
|
188
|
-
* <ul>
|
|
189
|
-
* <li>
|
|
190
|
-
* <p>
|
|
191
|
-
* <b>APPROVED</b> indicates that the associated CNAME
|
|
192
|
-
* has a valid ICP recordal number. Multiple CNAMEs can be associated with a
|
|
193
|
-
* distribution, and CNAMEs can correspond to different ICP recordals. To be marked
|
|
194
|
-
* as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP
|
|
195
|
-
* recordal number associated with it.</p>
|
|
196
|
-
* </li>
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>
|
|
199
|
-
* <b>SUSPENDED</b> indicates that the associated CNAME
|
|
200
|
-
* does not have a valid ICP recordal number.</p>
|
|
201
|
-
* </li>
|
|
202
|
-
* <li>
|
|
203
|
-
* <p>
|
|
204
|
-
* <b>PENDING</b> indicates that CloudFront can't determine
|
|
205
|
-
* the ICP recordal status of the CNAME associated with the distribution because
|
|
206
|
-
* there was an error in trying to determine the status. You can try again to see
|
|
207
|
-
* if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED
|
|
208
|
-
* status.</p>
|
|
209
|
-
* </li>
|
|
210
|
-
* </ul>
|
|
164
|
+
* <p>The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in Amazon Web Services Regions outside of China.</p> <p>The status values returned are the following:</p> <ul> <li> <p> <b>APPROVED</b> indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it.</p> </li> <li> <p> <b>SUSPENDED</b> indicates that the associated CNAME does not have a valid ICP recordal number.</p> </li> <li> <p> <b>PENDING</b> indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.</p> </li> </ul>
|
|
211
165
|
* @public
|
|
212
166
|
*/
|
|
213
167
|
ICPRecordalStatus?: ICPRecordalStatus | undefined;
|
|
@@ -230,92 +184,38 @@ export declare const Method: {
|
|
|
230
184
|
*/
|
|
231
185
|
export type Method = (typeof Method)[keyof typeof Method];
|
|
232
186
|
/**
|
|
233
|
-
* <p>A complex type that controls whether CloudFront caches the response to requests using the
|
|
234
|
-
* specified HTTP methods. There are two choices:</p>
|
|
235
|
-
* <ul>
|
|
236
|
-
* <li>
|
|
237
|
-
* <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code>
|
|
238
|
-
* requests.</p>
|
|
239
|
-
* </li>
|
|
240
|
-
* <li>
|
|
241
|
-
* <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and
|
|
242
|
-
* <code>OPTIONS</code> requests.</p>
|
|
243
|
-
* </li>
|
|
244
|
-
* </ul>
|
|
245
|
-
* <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward
|
|
246
|
-
* Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for
|
|
247
|
-
* the responses to be cached correctly.</p>
|
|
187
|
+
* <p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.</p>
|
|
248
188
|
* @public
|
|
249
189
|
*/
|
|
250
190
|
export interface CachedMethods {
|
|
251
191
|
/**
|
|
252
|
-
* <p>The number of HTTP methods for which you want CloudFront to cache responses. Valid values
|
|
253
|
-
* are <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code>
|
|
254
|
-
* requests) and <code>3</code> (for caching responses to <code>GET</code>,
|
|
255
|
-
* <code>HEAD</code>, and <code>OPTIONS</code> requests).</p>
|
|
192
|
+
* <p>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests).</p>
|
|
256
193
|
* @public
|
|
257
194
|
*/
|
|
258
195
|
Quantity: number | undefined;
|
|
259
196
|
/**
|
|
260
|
-
* <p>A complex type that contains the HTTP methods that you want CloudFront to cache responses
|
|
261
|
-
* to. Valid values for <code>CachedMethods</code> include <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code>, depending on which caching option you choose. For more information, see the preceding section.</p>
|
|
197
|
+
* <p>A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for <code>CachedMethods</code> include <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code>, depending on which caching option you choose. For more information, see the preceding section.</p>
|
|
262
198
|
* @public
|
|
263
199
|
*/
|
|
264
200
|
Items: Method[] | undefined;
|
|
265
201
|
}
|
|
266
202
|
/**
|
|
267
|
-
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your
|
|
268
|
-
* Amazon S3 bucket or your custom origin. There are three choices:</p>
|
|
269
|
-
* <ul>
|
|
270
|
-
* <li>
|
|
271
|
-
* <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p>
|
|
272
|
-
* </li>
|
|
273
|
-
* <li>
|
|
274
|
-
* <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and
|
|
275
|
-
* <code>OPTIONS</code> requests.</p>
|
|
276
|
-
* </li>
|
|
277
|
-
* <li>
|
|
278
|
-
* <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and
|
|
279
|
-
* <code>DELETE</code> requests.</p>
|
|
280
|
-
* </li>
|
|
281
|
-
* </ul>
|
|
282
|
-
* <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or
|
|
283
|
-
* to your custom origin so users can't perform operations that you don't want them to. For
|
|
284
|
-
* example, you might not want users to have permissions to delete objects from your
|
|
285
|
-
* origin.</p>
|
|
203
|
+
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>
|
|
286
204
|
* @public
|
|
287
205
|
*/
|
|
288
206
|
export interface AllowedMethods {
|
|
289
207
|
/**
|
|
290
|
-
* <p>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values
|
|
291
|
-
* are 2 (for <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>,
|
|
292
|
-
* <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD,
|
|
293
|
-
* OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</p>
|
|
208
|
+
* <p>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</p>
|
|
294
209
|
* @public
|
|
295
210
|
*/
|
|
296
211
|
Quantity: number | undefined;
|
|
297
212
|
/**
|
|
298
|
-
* <p>A complex type that contains the HTTP methods that you want CloudFront to process and
|
|
299
|
-
* forward to your origin.</p>
|
|
213
|
+
* <p>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</p>
|
|
300
214
|
* @public
|
|
301
215
|
*/
|
|
302
216
|
Items: Method[] | undefined;
|
|
303
217
|
/**
|
|
304
|
-
* <p>A complex type that controls whether CloudFront caches the response to requests using the
|
|
305
|
-
* specified HTTP methods. There are two choices:</p>
|
|
306
|
-
* <ul>
|
|
307
|
-
* <li>
|
|
308
|
-
* <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code>
|
|
309
|
-
* requests.</p>
|
|
310
|
-
* </li>
|
|
311
|
-
* <li>
|
|
312
|
-
* <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and
|
|
313
|
-
* <code>OPTIONS</code> requests.</p>
|
|
314
|
-
* </li>
|
|
315
|
-
* </ul>
|
|
316
|
-
* <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward
|
|
317
|
-
* Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for
|
|
318
|
-
* the responses to be cached correctly.</p>
|
|
218
|
+
* <p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.</p>
|
|
319
219
|
* @public
|
|
320
220
|
*/
|
|
321
221
|
CachedMethods?: CachedMethods | undefined;
|
|
@@ -408,27 +308,22 @@ export interface AnycastIpListCollection {
|
|
|
408
308
|
*/
|
|
409
309
|
Items?: AnycastIpListSummary[] | undefined;
|
|
410
310
|
/**
|
|
411
|
-
* <p>Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur
|
|
412
|
-
* after the marker. To get the next page of the list, set this field's value to the value
|
|
413
|
-
* of <code>NextMarker</code> from the current page's response.</p>
|
|
311
|
+
* <p>Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <code>NextMarker</code> from the current page's response.</p>
|
|
414
312
|
* @public
|
|
415
313
|
*/
|
|
416
314
|
Marker: string | undefined;
|
|
417
315
|
/**
|
|
418
|
-
* <p>Indicates the next page of the Anycast static IP list collection. To get the next page of the
|
|
419
|
-
* list, use this value in the <code>Marker</code> field of your request.</p>
|
|
316
|
+
* <p>Indicates the next page of the Anycast static IP list collection. To get the next page of the list, use this value in the <code>Marker</code> field of your request.</p>
|
|
420
317
|
* @public
|
|
421
318
|
*/
|
|
422
319
|
NextMarker?: string | undefined;
|
|
423
320
|
/**
|
|
424
|
-
* <p>The maximum number of Anycast static IP list collections that you want returned in the
|
|
425
|
-
* response.</p>
|
|
321
|
+
* <p>The maximum number of Anycast static IP list collections that you want returned in the response.</p>
|
|
426
322
|
* @public
|
|
427
323
|
*/
|
|
428
324
|
MaxItems: number | undefined;
|
|
429
325
|
/**
|
|
430
|
-
* <p>If there are more items in the list collection than are in this response, this value is
|
|
431
|
-
* <code>true</code>.</p>
|
|
326
|
+
* <p>If there are more items in the list collection than are in this response, this value is <code>true</code>.</p>
|
|
432
327
|
* @public
|
|
433
328
|
*/
|
|
434
329
|
IsTruncated: boolean | undefined;
|
|
@@ -572,8 +467,7 @@ export declare class InvalidIfMatchVersion extends __BaseException {
|
|
|
572
467
|
constructor(opts: __ExceptionOptionType<InvalidIfMatchVersion, __BaseException>);
|
|
573
468
|
}
|
|
574
469
|
/**
|
|
575
|
-
* <p>The precondition in one or more of the request fields evaluated to
|
|
576
|
-
* <code>false</code>.</p>
|
|
470
|
+
* <p>The precondition in one or more of the request fields evaluated to <code>false</code>.</p>
|
|
577
471
|
* @public
|
|
578
472
|
*/
|
|
579
473
|
export declare class PreconditionFailed extends __BaseException {
|
|
@@ -668,56 +562,17 @@ export interface CookieNames {
|
|
|
668
562
|
Items?: string[] | undefined;
|
|
669
563
|
}
|
|
670
564
|
/**
|
|
671
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
672
|
-
* request policy instead of this field.</p>
|
|
673
|
-
* <p>If you want to include cookies in the cache key, use <code>CookiesConfig</code> in a
|
|
674
|
-
* cache policy. See <code>CachePolicy</code>.</p>
|
|
675
|
-
* <p>If you want to send cookies to the origin but not include them in the cache key, use
|
|
676
|
-
* <code>CookiesConfig</code> in an origin request policy. See
|
|
677
|
-
* <code>OriginRequestPolicy</code>.</p>
|
|
678
|
-
* <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin
|
|
679
|
-
* and, if so, which ones. For more information about forwarding cookies to the origin, see
|
|
680
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html">Caching Content Based on
|
|
681
|
-
* Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
565
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use <code>CookiesConfig</code> in a cache policy. See <code>CachePolicy</code>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use <code>CookiesConfig</code> in an origin request policy. See <code>OriginRequestPolicy</code>.</p> <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html">Caching Content Based on Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
682
566
|
* @public
|
|
683
567
|
*/
|
|
684
568
|
export interface CookiePreference {
|
|
685
569
|
/**
|
|
686
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
687
|
-
* request policy instead of this field.</p>
|
|
688
|
-
* <p>If you want to include cookies in the cache key, use a cache policy. For more
|
|
689
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
690
|
-
* <p>If you want to send cookies to the origin but not include them in the cache key, use
|
|
691
|
-
* origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
692
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
693
|
-
* <p>Specifies which cookies to forward to the origin for this cache behavior: all, none,
|
|
694
|
-
* or the list of cookies specified in the <code>WhitelistedNames</code> complex
|
|
695
|
-
* type.</p>
|
|
696
|
-
* <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an
|
|
697
|
-
* Amazon S3 origin, specify none for the <code>Forward</code> element.</p>
|
|
570
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element.</p>
|
|
698
571
|
* @public
|
|
699
572
|
*/
|
|
700
573
|
Forward: ItemSelection | undefined;
|
|
701
574
|
/**
|
|
702
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
703
|
-
* request policy instead of this field.</p>
|
|
704
|
-
* <p>If you want to include cookies in the cache key, use a cache policy. For more
|
|
705
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
706
|
-
* <p>If you want to send cookies to the origin but not include them in the cache key, use
|
|
707
|
-
* an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
708
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
709
|
-
* <p>Required if you specify <code>whitelist</code> for the value of <code>Forward</code>.
|
|
710
|
-
* A complex type that specifies how many different cookies you want CloudFront to forward to the
|
|
711
|
-
* origin for this cache behavior and, if you want to forward selected cookies, the names
|
|
712
|
-
* of those cookies.</p>
|
|
713
|
-
* <p>If you specify <code>all</code> or <code>none</code> for the value of
|
|
714
|
-
* <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of
|
|
715
|
-
* <code>Forward</code> from <code>whitelist</code> to <code>all</code> or
|
|
716
|
-
* <code>none</code> and you don't delete the <code>WhitelistedNames</code> element and
|
|
717
|
-
* its child elements, CloudFront deletes them automatically.</p>
|
|
718
|
-
* <p>For the current limit on the number of cookie names that you can whitelist for each
|
|
719
|
-
* cache behavior, see <a href="https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront"> CloudFront
|
|
720
|
-
* Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
575
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>Required if you specify <code>whitelist</code> for the value of <code>Forward</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or <code>none</code> for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to <code>all</code> or <code>none</code> and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href="https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront"> CloudFront Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
721
576
|
* @public
|
|
722
577
|
*/
|
|
723
578
|
WhitelistedNames?: CookieNames | undefined;
|
|
@@ -739,117 +594,43 @@ export interface Headers {
|
|
|
739
594
|
Items?: string[] | undefined;
|
|
740
595
|
}
|
|
741
596
|
/**
|
|
742
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
743
|
-
* request policy instead of this field.</p>
|
|
744
|
-
* <p>If you want to include query strings in the cache key, use
|
|
745
|
-
* <code>QueryStringsConfig</code> in a cache policy. See
|
|
746
|
-
* <code>CachePolicy</code>.</p>
|
|
747
|
-
* <p>If you want to send query strings to the origin but not include them in the cache key,
|
|
748
|
-
* use <code>QueryStringsConfig</code> in an origin request policy. See
|
|
749
|
-
* <code>OriginRequestPolicy</code>.</p>
|
|
750
|
-
* <p>A complex type that contains information about the query string parameters that you
|
|
751
|
-
* want CloudFront to use for caching for a cache behavior.</p>
|
|
597
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include query strings in the cache key, use <code>QueryStringsConfig</code> in a cache policy. See <code>CachePolicy</code>.</p> <p>If you want to send query strings to the origin but not include them in the cache key, use <code>QueryStringsConfig</code> in an origin request policy. See <code>OriginRequestPolicy</code>.</p> <p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.</p>
|
|
752
598
|
* @public
|
|
753
599
|
*/
|
|
754
600
|
export interface QueryStringCacheKeys {
|
|
755
601
|
/**
|
|
756
|
-
* <p>The number of <code>whitelisted</code> query string parameters for a cache
|
|
757
|
-
* behavior.</p>
|
|
602
|
+
* <p>The number of <code>whitelisted</code> query string parameters for a cache behavior.</p>
|
|
758
603
|
* @public
|
|
759
604
|
*/
|
|
760
605
|
Quantity: number | undefined;
|
|
761
606
|
/**
|
|
762
|
-
* <p>A list that contains the query string parameters that you want CloudFront to use as a basis
|
|
763
|
-
* for caching for a cache behavior. If <code>Quantity</code> is 0, you can omit
|
|
764
|
-
* <code>Items</code>.</p>
|
|
607
|
+
* <p>A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If <code>Quantity</code> is 0, you can omit <code>Items</code>.</p>
|
|
765
608
|
* @public
|
|
766
609
|
*/
|
|
767
610
|
Items?: string[] | undefined;
|
|
768
611
|
}
|
|
769
612
|
/**
|
|
770
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
771
|
-
* request policy instead of this field.</p>
|
|
772
|
-
* <p>If you want to include values in the cache key, use a cache policy. For more
|
|
773
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
774
|
-
* <p>If you want to send values to the origin but not include them in the cache key, use an
|
|
775
|
-
* origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
776
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
777
|
-
* <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP
|
|
778
|
-
* headers.</p>
|
|
613
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>
|
|
779
614
|
* @public
|
|
780
615
|
*/
|
|
781
616
|
export interface ForwardedValues {
|
|
782
617
|
/**
|
|
783
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
784
|
-
* request policy instead of this field.</p>
|
|
785
|
-
* <p>If you want to include query strings in the cache key, use a cache policy. For more
|
|
786
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
787
|
-
* <p>If you want to send query strings to the origin but not include them in the cache key,
|
|
788
|
-
* use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
789
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
790
|
-
* <p>Indicates whether you want CloudFront to forward query strings to the origin that is
|
|
791
|
-
* associated with this cache behavior and cache based on the query string parameters. CloudFront
|
|
792
|
-
* behavior depends on the value of <code>QueryString</code> and on the values that you
|
|
793
|
-
* specify for <code>QueryStringCacheKeys</code>, if any:</p>
|
|
794
|
-
* <p>If you specify true for <code>QueryString</code> and you don't specify any values for
|
|
795
|
-
* <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the
|
|
796
|
-
* origin and caches based on all query string parameters. Depending on how many query
|
|
797
|
-
* string parameters and values you have, this can adversely affect performance because
|
|
798
|
-
* CloudFront must forward more requests to the origin.</p>
|
|
799
|
-
* <p>If you specify true for <code>QueryString</code> and you specify one or more values
|
|
800
|
-
* for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the
|
|
801
|
-
* origin, but it only caches based on the query string parameters that you specify.</p>
|
|
802
|
-
* <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query
|
|
803
|
-
* string parameters to the origin, and doesn't cache based on query string
|
|
804
|
-
* parameters.</p>
|
|
805
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html">Configuring
|
|
806
|
-
* CloudFront to Cache Based on Query String Parameters</a> in the
|
|
807
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
618
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include query strings in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
808
619
|
* @public
|
|
809
620
|
*/
|
|
810
621
|
QueryString: boolean | undefined;
|
|
811
622
|
/**
|
|
812
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
813
|
-
* request policy instead of this field.</p>
|
|
814
|
-
* <p>If you want to include cookies in the cache key, use a cache policy. For more
|
|
815
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
816
|
-
* <p>If you want to send cookies to the origin but not include them in the cache key, use
|
|
817
|
-
* an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
818
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
819
|
-
* <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin
|
|
820
|
-
* and, if so, which ones. For more information about forwarding cookies to the origin, see
|
|
821
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html">How CloudFront Forwards, Caches,
|
|
822
|
-
* and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
623
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
823
624
|
* @public
|
|
824
625
|
*/
|
|
825
626
|
Cookies: CookiePreference | undefined;
|
|
826
627
|
/**
|
|
827
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
828
|
-
* request policy instead of this field.</p>
|
|
829
|
-
* <p>If you want to include headers in the cache key, use a cache policy. For more
|
|
830
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
831
|
-
* <p>If you want to send headers to the origin but not include them in the cache key, use
|
|
832
|
-
* an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
833
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
834
|
-
* <p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to
|
|
835
|
-
* forward to the origin for this cache behavior (whitelisted headers). For the headers
|
|
836
|
-
* that you specify, CloudFront also caches separate versions of a specified object that is based
|
|
837
|
-
* on the header values in viewer requests.</p>
|
|
838
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html"> Caching Content
|
|
839
|
-
* Based on Request Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
628
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include headers in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html"> Caching Content Based on Request Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
840
629
|
* @public
|
|
841
630
|
*/
|
|
842
631
|
Headers?: Headers | undefined;
|
|
843
632
|
/**
|
|
844
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
845
|
-
* request policy instead of this field.</p>
|
|
846
|
-
* <p>If you want to include query strings in the cache key, use a cache policy. For more
|
|
847
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
848
|
-
* <p>If you want to send query strings to the origin but not include them in the cache key,
|
|
849
|
-
* use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the
|
|
850
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
851
|
-
* <p>A complex type that contains information about the query string parameters that you
|
|
852
|
-
* want CloudFront to use for caching for this cache behavior.</p>
|
|
633
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include query strings in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.</p>
|
|
853
634
|
* @public
|
|
854
635
|
*/
|
|
855
636
|
QueryStringCacheKeys?: QueryStringCacheKeys | undefined;
|
|
@@ -869,8 +650,7 @@ export declare const EventType: {
|
|
|
869
650
|
*/
|
|
870
651
|
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
871
652
|
/**
|
|
872
|
-
* <p>A CloudFront function that is associated with a cache behavior in a CloudFront
|
|
873
|
-
* distribution.</p>
|
|
653
|
+
* <p>A CloudFront function that is associated with a cache behavior in a CloudFront distribution.</p>
|
|
874
654
|
* @public
|
|
875
655
|
*/
|
|
876
656
|
export interface FunctionAssociation {
|
|
@@ -880,18 +660,13 @@ export interface FunctionAssociation {
|
|
|
880
660
|
*/
|
|
881
661
|
FunctionARN: string | undefined;
|
|
882
662
|
/**
|
|
883
|
-
* <p>The event type of the function, either <code>viewer-request</code> or
|
|
884
|
-
* <code>viewer-response</code>. You cannot use origin-facing event types
|
|
885
|
-
* (<code>origin-request</code> and <code>origin-response</code>) with a CloudFront
|
|
886
|
-
* function.</p>
|
|
663
|
+
* <p>The event type of the function, either <code>viewer-request</code> or <code>viewer-response</code>. You cannot use origin-facing event types (<code>origin-request</code> and <code>origin-response</code>) with a CloudFront function.</p>
|
|
887
664
|
* @public
|
|
888
665
|
*/
|
|
889
666
|
EventType: EventType | undefined;
|
|
890
667
|
}
|
|
891
668
|
/**
|
|
892
|
-
* <p>A list of CloudFront functions that are associated with a cache behavior in a CloudFront
|
|
893
|
-
* distribution. Your functions must be published to the <code>LIVE</code> stage to
|
|
894
|
-
* associate them with a cache behavior.</p>
|
|
669
|
+
* <p>A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the <code>LIVE</code> stage to associate them with a cache behavior.</p>
|
|
895
670
|
* @public
|
|
896
671
|
*/
|
|
897
672
|
export interface FunctionAssociations {
|
|
@@ -901,26 +676,18 @@ export interface FunctionAssociations {
|
|
|
901
676
|
*/
|
|
902
677
|
Quantity: number | undefined;
|
|
903
678
|
/**
|
|
904
|
-
* <p>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution.
|
|
905
|
-
* Your functions must be published to the <code>LIVE</code> stage to associate them with a
|
|
906
|
-
* cache behavior.</p>
|
|
679
|
+
* <p>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the <code>LIVE</code> stage to associate them with a cache behavior.</p>
|
|
907
680
|
* @public
|
|
908
681
|
*/
|
|
909
682
|
Items?: FunctionAssociation[] | undefined;
|
|
910
683
|
}
|
|
911
684
|
/**
|
|
912
|
-
* <p>Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on
|
|
913
|
-
* HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads,
|
|
914
|
-
* making it suitable for applications that require low latency communications.</p>
|
|
915
|
-
* <p>To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported <code>HTTP</code> versions and allow <code>HTTP</code> methods, including <code>POST</code>.</p>
|
|
916
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html">Using gRPC with CloudFront distributions</a> in the
|
|
917
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
685
|
+
* <p>Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications.</p> <p>To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported <code>HTTP</code> versions and allow <code>HTTP</code> methods, including <code>POST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html">Using gRPC with CloudFront distributions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
918
686
|
* @public
|
|
919
687
|
*/
|
|
920
688
|
export interface GrpcConfig {
|
|
921
689
|
/**
|
|
922
|
-
* <p>Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your
|
|
923
|
-
* origins.</p>
|
|
690
|
+
* <p>Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.</p>
|
|
924
691
|
* @public
|
|
925
692
|
*/
|
|
926
693
|
Enabled: boolean | undefined;
|
|
@@ -931,65 +698,23 @@ export interface GrpcConfig {
|
|
|
931
698
|
*/
|
|
932
699
|
export interface LambdaFunctionAssociation {
|
|
933
700
|
/**
|
|
934
|
-
* <p>The ARN of the Lambda@Edge function. You must specify the ARN of a function version;
|
|
935
|
-
* you can't specify an alias or $LATEST.</p>
|
|
701
|
+
* <p>The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.</p>
|
|
936
702
|
* @public
|
|
937
703
|
*/
|
|
938
704
|
LambdaFunctionARN: string | undefined;
|
|
939
705
|
/**
|
|
940
|
-
* <p>Specifies the event type that triggers a Lambda@Edge function invocation. You can
|
|
941
|
-
* specify the following values:</p>
|
|
942
|
-
* <ul>
|
|
943
|
-
* <li>
|
|
944
|
-
* <p>
|
|
945
|
-
* <code>viewer-request</code>: The function executes when CloudFront receives a
|
|
946
|
-
* request from a viewer and before it checks to see whether the requested object
|
|
947
|
-
* is in the edge cache.</p>
|
|
948
|
-
* </li>
|
|
949
|
-
* <li>
|
|
950
|
-
* <p>
|
|
951
|
-
* <code>origin-request</code>: The function executes only when CloudFront sends a
|
|
952
|
-
* request to your origin. When the requested object is in the edge cache, the
|
|
953
|
-
* function doesn't execute.</p>
|
|
954
|
-
* </li>
|
|
955
|
-
* <li>
|
|
956
|
-
* <p>
|
|
957
|
-
* <code>origin-response</code>: The function executes after CloudFront receives a
|
|
958
|
-
* response from the origin and before it caches the object in the response. When
|
|
959
|
-
* the requested object is in the edge cache, the function doesn't execute.</p>
|
|
960
|
-
* </li>
|
|
961
|
-
* <li>
|
|
962
|
-
* <p>
|
|
963
|
-
* <code>viewer-response</code>: The function executes before CloudFront returns the
|
|
964
|
-
* requested object to the viewer. The function executes regardless of whether the
|
|
965
|
-
* object was already in the edge cache.</p>
|
|
966
|
-
* <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the
|
|
967
|
-
* function doesn't execute.</p>
|
|
968
|
-
* </li>
|
|
969
|
-
* </ul>
|
|
706
|
+
* <p>Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:</p> <ul> <li> <p> <code>viewer-request</code>: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.</p> </li> <li> <p> <code>origin-request</code>: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>origin-response</code>: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>viewer-response</code>: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> </ul>
|
|
970
707
|
* @public
|
|
971
708
|
*/
|
|
972
709
|
EventType: EventType | undefined;
|
|
973
710
|
/**
|
|
974
|
-
* <p>A flag that allows a Lambda@Edge function to have read access to the body content. For
|
|
975
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html">Accessing the Request Body by Choosing the Include Body Option</a> in the
|
|
976
|
-
* Amazon CloudFront Developer Guide.</p>
|
|
711
|
+
* <p>A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html">Accessing the Request Body by Choosing the Include Body Option</a> in the Amazon CloudFront Developer Guide.</p>
|
|
977
712
|
* @public
|
|
978
713
|
*/
|
|
979
714
|
IncludeBody?: boolean | undefined;
|
|
980
715
|
}
|
|
981
716
|
/**
|
|
982
|
-
* <p>A complex type that specifies a list of Lambda@Edge functions associations for a cache
|
|
983
|
-
* behavior.</p>
|
|
984
|
-
* <p>If you want to invoke one or more Lambda@Edge functions triggered by requests that
|
|
985
|
-
* match the <code>PathPattern</code> of the cache behavior, specify the applicable values
|
|
986
|
-
* for <code>Quantity</code> and <code>Items</code>. Note that there can be up to 4
|
|
987
|
-
* <code>LambdaFunctionAssociation</code> items in this list (one for each possible
|
|
988
|
-
* value of <code>EventType</code>) and each <code>EventType</code> can be associated with
|
|
989
|
-
* only one function.</p>
|
|
990
|
-
* <p>If you don't want to invoke any Lambda@Edge functions for the requests that match
|
|
991
|
-
* <code>PathPattern</code>, specify <code>0</code> for <code>Quantity</code> and omit
|
|
992
|
-
* <code>Items</code>.</p>
|
|
717
|
+
* <p>A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior.</p> <p>If you want to invoke one or more Lambda@Edge functions triggered by requests that match the <code>PathPattern</code> of the cache behavior, specify the applicable values for <code>Quantity</code> and <code>Items</code>. Note that there can be up to 4 <code>LambdaFunctionAssociation</code> items in this list (one for each possible value of <code>EventType</code>) and each <code>EventType</code> can be associated with only one function.</p> <p>If you don't want to invoke any Lambda@Edge functions for the requests that match <code>PathPattern</code>, specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>.</p>
|
|
993
718
|
* @public
|
|
994
719
|
*/
|
|
995
720
|
export interface LambdaFunctionAssociations {
|
|
@@ -999,24 +724,18 @@ export interface LambdaFunctionAssociations {
|
|
|
999
724
|
*/
|
|
1000
725
|
Quantity: number | undefined;
|
|
1001
726
|
/**
|
|
1002
|
-
* <p>
|
|
1003
|
-
* <b>Optional</b>: A complex type that contains
|
|
1004
|
-
* <code>LambdaFunctionAssociation</code> items for this cache behavior. If
|
|
1005
|
-
* <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>
|
|
727
|
+
* <p> <b>Optional</b>: A complex type that contains <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>
|
|
1006
728
|
* @public
|
|
1007
729
|
*/
|
|
1008
730
|
Items?: LambdaFunctionAssociation[] | undefined;
|
|
1009
731
|
}
|
|
1010
732
|
/**
|
|
1011
|
-
* <p>A list of key groups whose public keys CloudFront can use to verify the signatures of signed
|
|
1012
|
-
* URLs and signed cookies.</p>
|
|
733
|
+
* <p>A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
1013
734
|
* @public
|
|
1014
735
|
*/
|
|
1015
736
|
export interface TrustedKeyGroups {
|
|
1016
737
|
/**
|
|
1017
|
-
* <p>This field is <code>true</code> if any of the key groups in the list have public keys
|
|
1018
|
-
* that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not,
|
|
1019
|
-
* this field is <code>false</code>.</p>
|
|
738
|
+
* <p>This field is <code>true</code> if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is <code>false</code>.</p>
|
|
1020
739
|
* @public
|
|
1021
740
|
*/
|
|
1022
741
|
Enabled: boolean | undefined;
|
|
@@ -1032,14 +751,12 @@ export interface TrustedKeyGroups {
|
|
|
1032
751
|
Items?: string[] | undefined;
|
|
1033
752
|
}
|
|
1034
753
|
/**
|
|
1035
|
-
* <p>A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of
|
|
1036
|
-
* signed URLs and signed cookies.</p>
|
|
754
|
+
* <p>A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>
|
|
1037
755
|
* @public
|
|
1038
756
|
*/
|
|
1039
757
|
export interface TrustedSigners {
|
|
1040
758
|
/**
|
|
1041
|
-
* <p>This field is <code>true</code> if any of the Amazon Web Services accounts in the list are configured as
|
|
1042
|
-
* trusted signers. If not, this field is <code>false</code>.</p>
|
|
759
|
+
* <p>This field is <code>true</code> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <code>false</code>.</p>
|
|
1043
760
|
* @public
|
|
1044
761
|
*/
|
|
1045
762
|
Enabled: boolean | undefined;
|
|
@@ -1068,196 +785,77 @@ export declare const ViewerProtocolPolicy: {
|
|
|
1068
785
|
*/
|
|
1069
786
|
export type ViewerProtocolPolicy = (typeof ViewerProtocolPolicy)[keyof typeof ViewerProtocolPolicy];
|
|
1070
787
|
/**
|
|
1071
|
-
* <p>A complex type that describes how CloudFront processes requests.</p>
|
|
1072
|
-
* <p>You must create at least as many cache behaviors (including the default cache
|
|
1073
|
-
* behavior) as you have origins if you want CloudFront to serve objects from all of the origins.
|
|
1074
|
-
* Each cache behavior specifies the one origin from which you want CloudFront to get objects. If
|
|
1075
|
-
* you have two origins and only the default cache behavior, the default cache behavior
|
|
1076
|
-
* will cause CloudFront to get objects from one of the origins, but the other origin is never
|
|
1077
|
-
* used.</p>
|
|
1078
|
-
* <p>For the current quota (formerly known as limit) on the number of cache behaviors that
|
|
1079
|
-
* you can add to a distribution, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> in the
|
|
1080
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1081
|
-
* <p>If you don't want to specify any cache behaviors, include only an empty
|
|
1082
|
-
* <code>CacheBehaviors</code> element. Don't specify an empty individual
|
|
1083
|
-
* <code>CacheBehavior</code> element, because this is invalid. For more information,
|
|
1084
|
-
* see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html">CacheBehaviors</a>. </p>
|
|
1085
|
-
* <p>To delete all cache behaviors in an existing distribution, update the distribution
|
|
1086
|
-
* configuration and include only an empty <code>CacheBehaviors</code> element.</p>
|
|
1087
|
-
* <p>To add, change, or remove one or more cache behaviors, update the distribution
|
|
1088
|
-
* configuration and specify all of the cache behaviors that you want to include in the
|
|
1089
|
-
* updated distribution.</p>
|
|
1090
|
-
* <p>For more information about cache behaviors, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
788
|
+
* <p>A complex type that describes how CloudFront processes requests.</p> <p>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.</p> <p>For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to specify any cache behaviors, include only an empty <code>CacheBehaviors</code> element. Don't specify an empty individual <code>CacheBehavior</code> element, because this is invalid. For more information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html">CacheBehaviors</a>. </p> <p>To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty <code>CacheBehaviors</code> element.</p> <p>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.</p> <p>For more information about cache behaviors, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1091
789
|
* @public
|
|
1092
790
|
*/
|
|
1093
791
|
export interface CacheBehavior {
|
|
1094
792
|
/**
|
|
1095
|
-
* <p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to
|
|
1096
|
-
* apply the behavior to. When CloudFront receives a viewer request, the requested path is
|
|
1097
|
-
* compared with path patterns in the order in which cache behaviors are listed in the
|
|
1098
|
-
* distribution.</p>
|
|
1099
|
-
* <note>
|
|
1100
|
-
* <p>You can optionally include a slash (<code>/</code>) at the beginning of the path
|
|
1101
|
-
* pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or
|
|
1102
|
-
* without the leading <code>/</code>.</p>
|
|
1103
|
-
* </note>
|
|
1104
|
-
* <p>The path pattern for the default cache behavior is <code>*</code> and cannot be
|
|
1105
|
-
* changed. If the request for an object does not match the path pattern for any cache
|
|
1106
|
-
* behaviors, CloudFront applies the behavior in the default cache behavior.</p>
|
|
1107
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>
|
|
793
|
+
* <p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>
|
|
1108
794
|
* @public
|
|
1109
795
|
*/
|
|
1110
796
|
PathPattern: string | undefined;
|
|
1111
797
|
/**
|
|
1112
|
-
* <p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to
|
|
1113
|
-
* when they match this cache behavior.</p>
|
|
798
|
+
* <p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when they match this cache behavior.</p>
|
|
1114
799
|
* @public
|
|
1115
800
|
*/
|
|
1116
801
|
TargetOriginId: string | undefined;
|
|
1117
802
|
/**
|
|
1118
|
-
* <important>
|
|
1119
|
-
* <p>We recommend using <code>TrustedKeyGroups</code> instead of
|
|
1120
|
-
* <code>TrustedSigners</code>.</p>
|
|
1121
|
-
* </important>
|
|
1122
|
-
* <p>A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or
|
|
1123
|
-
* signed cookies.</p>
|
|
1124
|
-
* <p>When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed
|
|
1125
|
-
* cookies for all requests that match the cache behavior. The URLs or cookies must be
|
|
1126
|
-
* signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account.
|
|
1127
|
-
* The signed URL or cookie contains information about which public key CloudFront should use to
|
|
1128
|
-
* verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the
|
|
1129
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
803
|
+
* <important> <p>We recommend using <code>TrustedKeyGroups</code> instead of <code>TrustedSigners</code>.</p> </important> <p>A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.</p> <p>When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1130
804
|
* @public
|
|
1131
805
|
*/
|
|
1132
806
|
TrustedSigners?: TrustedSigners | undefined;
|
|
1133
807
|
/**
|
|
1134
|
-
* <p>A list of key groups that CloudFront can use to validate signed URLs or signed
|
|
1135
|
-
* cookies.</p>
|
|
1136
|
-
* <p>When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed
|
|
1137
|
-
* cookies for all requests that match the cache behavior. The URLs or cookies must be
|
|
1138
|
-
* signed with a private key whose corresponding public key is in the key group. The signed
|
|
1139
|
-
* URL or cookie contains information about which public key CloudFront should use to verify the
|
|
1140
|
-
* signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the
|
|
1141
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
808
|
+
* <p>A list of key groups that CloudFront can use to validate signed URLs or signed cookies.</p> <p>When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1142
809
|
* @public
|
|
1143
810
|
*/
|
|
1144
811
|
TrustedKeyGroups?: TrustedKeyGroups | undefined;
|
|
1145
812
|
/**
|
|
1146
|
-
* <p>The protocol that viewers can use to access the files in the origin specified by
|
|
1147
|
-
* <code>TargetOriginId</code> when a request matches the path pattern in
|
|
1148
|
-
* <code>PathPattern</code>. You can specify the following options:</p>
|
|
1149
|
-
* <ul>
|
|
1150
|
-
* <li>
|
|
1151
|
-
* <p>
|
|
1152
|
-
* <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p>
|
|
1153
|
-
* </li>
|
|
1154
|
-
* <li>
|
|
1155
|
-
* <p>
|
|
1156
|
-
* <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront
|
|
1157
|
-
* returns an HTTP status code of 301 (Moved Permanently) to the viewer along with
|
|
1158
|
-
* the HTTPS URL. The viewer then resubmits the request using the new URL.</p>
|
|
1159
|
-
* </li>
|
|
1160
|
-
* <li>
|
|
1161
|
-
* <p>
|
|
1162
|
-
* <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an
|
|
1163
|
-
* HTTP status code of 403 (Forbidden).</p>
|
|
1164
|
-
* </li>
|
|
1165
|
-
* </ul>
|
|
1166
|
-
* <p>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the
|
|
1167
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1168
|
-
* <note>
|
|
1169
|
-
* <p>The only way to guarantee that viewers retrieve an object that was fetched from
|
|
1170
|
-
* the origin using HTTPS is never to use any other protocol to fetch the object. If
|
|
1171
|
-
* you have recently changed from HTTP to HTTPS, we recommend that you clear your
|
|
1172
|
-
* objects' cache because cached objects are protocol agnostic. That means that an edge
|
|
1173
|
-
* location will return an object from the cache regardless of whether the current
|
|
1174
|
-
* request protocol matches the protocol used previously. For more information, see
|
|
1175
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache
|
|
1176
|
-
* Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1177
|
-
* </note>
|
|
813
|
+
* <p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>
|
|
1178
814
|
* @public
|
|
1179
815
|
*/
|
|
1180
816
|
ViewerProtocolPolicy: ViewerProtocolPolicy | undefined;
|
|
1181
817
|
/**
|
|
1182
|
-
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your
|
|
1183
|
-
* Amazon S3 bucket or your custom origin. There are three choices:</p>
|
|
1184
|
-
* <ul>
|
|
1185
|
-
* <li>
|
|
1186
|
-
* <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p>
|
|
1187
|
-
* </li>
|
|
1188
|
-
* <li>
|
|
1189
|
-
* <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and
|
|
1190
|
-
* <code>OPTIONS</code> requests.</p>
|
|
1191
|
-
* </li>
|
|
1192
|
-
* <li>
|
|
1193
|
-
* <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and
|
|
1194
|
-
* <code>DELETE</code> requests.</p>
|
|
1195
|
-
* </li>
|
|
1196
|
-
* </ul>
|
|
1197
|
-
* <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or
|
|
1198
|
-
* to your custom origin so users can't perform operations that you don't want them to. For
|
|
1199
|
-
* example, you might not want users to have permissions to delete objects from your
|
|
1200
|
-
* origin.</p>
|
|
818
|
+
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>
|
|
1201
819
|
* @public
|
|
1202
820
|
*/
|
|
1203
821
|
AllowedMethods?: AllowedMethods | undefined;
|
|
1204
822
|
/**
|
|
1205
|
-
* <p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming
|
|
1206
|
-
* format using the origin that is associated with this cache behavior. If so, specify
|
|
1207
|
-
* <code>true</code>; if not, specify <code>false</code>. If you specify
|
|
1208
|
-
* <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other
|
|
1209
|
-
* content using this cache behavior if the content matches the value of
|
|
1210
|
-
* <code>PathPattern</code>.</p>
|
|
823
|
+
* <p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>.</p>
|
|
1211
824
|
* @public
|
|
1212
825
|
*/
|
|
1213
826
|
SmoothStreaming?: boolean | undefined;
|
|
1214
827
|
/**
|
|
1215
|
-
* <p>Whether you want CloudFront to automatically compress certain files for this cache behavior.
|
|
1216
|
-
* If so, specify true; if not, specify false. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving
|
|
1217
|
-
* Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
828
|
+
* <p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1218
829
|
* @public
|
|
1219
830
|
*/
|
|
1220
831
|
Compress?: boolean | undefined;
|
|
1221
832
|
/**
|
|
1222
|
-
* <p>A complex type that contains zero or more Lambda@Edge function associations for a
|
|
1223
|
-
* cache behavior.</p>
|
|
833
|
+
* <p>A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.</p>
|
|
1224
834
|
* @public
|
|
1225
835
|
*/
|
|
1226
836
|
LambdaFunctionAssociations?: LambdaFunctionAssociations | undefined;
|
|
1227
837
|
/**
|
|
1228
|
-
* <p>A list of CloudFront functions that are associated with this cache behavior. CloudFront functions
|
|
1229
|
-
* must be published to the <code>LIVE</code> stage to associate them with a cache
|
|
1230
|
-
* behavior.</p>
|
|
838
|
+
* <p>A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the <code>LIVE</code> stage to associate them with a cache behavior.</p>
|
|
1231
839
|
* @public
|
|
1232
840
|
*/
|
|
1233
841
|
FunctionAssociations?: FunctionAssociations | undefined;
|
|
1234
842
|
/**
|
|
1235
|
-
* <p>The value of <code>ID</code> for the field-level encryption configuration that you
|
|
1236
|
-
* want CloudFront to use for encrypting specific fields of data for this cache behavior.</p>
|
|
843
|
+
* <p>The value of <code>ID</code> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.</p>
|
|
1237
844
|
* @public
|
|
1238
845
|
*/
|
|
1239
846
|
FieldLevelEncryptionId?: string | undefined;
|
|
1240
847
|
/**
|
|
1241
|
-
* <p>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to
|
|
1242
|
-
* this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the
|
|
1243
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
848
|
+
* <p>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1244
849
|
* @public
|
|
1245
850
|
*/
|
|
1246
851
|
RealtimeLogConfigArn?: string | undefined;
|
|
1247
852
|
/**
|
|
1248
|
-
* <p>The unique identifier of the cache policy that is attached to this cache behavior. For
|
|
1249
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
1250
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1251
|
-
* <p>A <code>CacheBehavior</code> must include either a <code>CachePolicyId</code> or
|
|
1252
|
-
* <code>ForwardedValues</code>. We recommend that you use a
|
|
1253
|
-
* <code>CachePolicyId</code>.</p>
|
|
853
|
+
* <p>The unique identifier of the cache policy that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>CacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p>
|
|
1254
854
|
* @public
|
|
1255
855
|
*/
|
|
1256
856
|
CachePolicyId?: string | undefined;
|
|
1257
857
|
/**
|
|
1258
|
-
* <p>The unique identifier of the origin request policy that is attached to this cache
|
|
1259
|
-
* behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the
|
|
1260
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
858
|
+
* <p>The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1261
859
|
* @public
|
|
1262
860
|
*/
|
|
1263
861
|
OriginRequestPolicyId?: string | undefined;
|
|
@@ -1272,68 +870,28 @@ export interface CacheBehavior {
|
|
|
1272
870
|
*/
|
|
1273
871
|
GrpcConfig?: GrpcConfig | undefined;
|
|
1274
872
|
/**
|
|
1275
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
1276
|
-
* request policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the
|
|
1277
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1278
|
-
* <p>If you want to include values in the cache key, use a cache policy. For more
|
|
1279
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
1280
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1281
|
-
* <p>If you want to send values to the origin but not include them in the cache key, use an
|
|
1282
|
-
* origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the
|
|
1283
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1284
|
-
* <p>A <code>CacheBehavior</code> must include either a <code>CachePolicyId</code> or
|
|
1285
|
-
* <code>ForwardedValues</code>. We recommend that you use a
|
|
1286
|
-
* <code>CachePolicyId</code>.</p>
|
|
1287
|
-
* <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP
|
|
1288
|
-
* headers.</p>
|
|
873
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>CacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>
|
|
1289
874
|
*
|
|
1290
875
|
* @deprecated
|
|
1291
876
|
* @public
|
|
1292
877
|
*/
|
|
1293
878
|
ForwardedValues?: ForwardedValues | undefined;
|
|
1294
879
|
/**
|
|
1295
|
-
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a
|
|
1296
|
-
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
1297
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1298
|
-
* <p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
1299
|
-
* forwards another request to your origin to determine whether the object has been
|
|
1300
|
-
* updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html"> Managing How Long
|
|
1301
|
-
* Content Stays in an Edge Cache (Expiration)</a> in the <i>
|
|
1302
|
-
* Amazon CloudFront Developer Guide</i>.</p>
|
|
1303
|
-
* <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to
|
|
1304
|
-
* forward all headers to your origin (under <code>Headers</code>, if you specify
|
|
1305
|
-
* <code>1</code> for <code>Quantity</code> and <code>*</code> for
|
|
1306
|
-
* <code>Name</code>).</p>
|
|
880
|
+
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html"> Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i> Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>
|
|
1307
881
|
*
|
|
1308
882
|
* @deprecated
|
|
1309
883
|
* @public
|
|
1310
884
|
*/
|
|
1311
885
|
MinTTL?: number | undefined;
|
|
1312
886
|
/**
|
|
1313
|
-
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field
|
|
1314
|
-
* in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
1315
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1316
|
-
* <p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
1317
|
-
* forwards another request to your origin to determine whether the object has been
|
|
1318
|
-
* updated. The value that you specify applies only when your origin does not add HTTP
|
|
1319
|
-
* headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>,
|
|
1320
|
-
* and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
1321
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
887
|
+
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1322
888
|
*
|
|
1323
889
|
* @deprecated
|
|
1324
890
|
* @public
|
|
1325
891
|
*/
|
|
1326
892
|
DefaultTTL?: number | undefined;
|
|
1327
893
|
/**
|
|
1328
|
-
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a
|
|
1329
|
-
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
1330
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1331
|
-
* <p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
1332
|
-
* forwards another request to your origin to determine whether the object has been
|
|
1333
|
-
* updated. The value that you specify applies only when your origin adds HTTP headers such
|
|
1334
|
-
* as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and
|
|
1335
|
-
* <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
1336
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
894
|
+
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1337
895
|
*
|
|
1338
896
|
* @deprecated
|
|
1339
897
|
* @public
|
|
@@ -1351,8 +909,7 @@ export interface CacheBehaviors {
|
|
|
1351
909
|
*/
|
|
1352
910
|
Quantity: number | undefined;
|
|
1353
911
|
/**
|
|
1354
|
-
* <p>Optional: A complex type that contains cache behaviors for this distribution. If
|
|
1355
|
-
* <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>
|
|
912
|
+
* <p>Optional: A complex type that contains cache behaviors for this distribution. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>
|
|
1356
913
|
* @public
|
|
1357
914
|
*/
|
|
1358
915
|
Items?: CacheBehavior[] | undefined;
|
|
@@ -1372,44 +929,12 @@ export declare const CachePolicyCookieBehavior: {
|
|
|
1372
929
|
*/
|
|
1373
930
|
export type CachePolicyCookieBehavior = (typeof CachePolicyCookieBehavior)[keyof typeof CachePolicyCookieBehavior];
|
|
1374
931
|
/**
|
|
1375
|
-
* <p>An object that determines whether any cookies in viewer requests (and if so, which cookies)
|
|
1376
|
-
* are included in the cache key and in requests that CloudFront sends to the origin.</p>
|
|
932
|
+
* <p>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.</p>
|
|
1377
933
|
* @public
|
|
1378
934
|
*/
|
|
1379
935
|
export interface CachePolicyCookiesConfig {
|
|
1380
936
|
/**
|
|
1381
|
-
* <p>Determines whether any cookies in viewer requests are included in the cache key and in
|
|
1382
|
-
* requests that CloudFront sends to the origin. Valid values are:</p>
|
|
1383
|
-
* <ul>
|
|
1384
|
-
* <li>
|
|
1385
|
-
* <p>
|
|
1386
|
-
* <code>none</code> – No cookies in viewer requests are included in the cache key or in
|
|
1387
|
-
* requests that CloudFront sends to the origin. Even when this field is set to
|
|
1388
|
-
* <code>none</code>, any cookies that are listed in an
|
|
1389
|
-
* <code>OriginRequestPolicy</code>
|
|
1390
|
-
* <i>are</i> included in origin
|
|
1391
|
-
* requests.</p>
|
|
1392
|
-
* </li>
|
|
1393
|
-
* <li>
|
|
1394
|
-
* <p>
|
|
1395
|
-
* <code>whitelist</code> – Only the cookies in viewer requests that are listed in the
|
|
1396
|
-
* <code>CookieNames</code> type are included in the cache key and in requests that
|
|
1397
|
-
* CloudFront sends to the origin.</p>
|
|
1398
|
-
* </li>
|
|
1399
|
-
* <li>
|
|
1400
|
-
* <p>
|
|
1401
|
-
* <code>allExcept</code> – All cookies in viewer requests are included in the cache key and
|
|
1402
|
-
* in requests that CloudFront sends to the origin, <i>
|
|
1403
|
-
* <b>except</b>
|
|
1404
|
-
* </i> for those that are listed in the
|
|
1405
|
-
* <code>CookieNames</code> type, which are not included.</p>
|
|
1406
|
-
* </li>
|
|
1407
|
-
* <li>
|
|
1408
|
-
* <p>
|
|
1409
|
-
* <code>all</code> – All cookies in viewer requests are included in the cache key and in
|
|
1410
|
-
* requests that CloudFront sends to the origin.</p>
|
|
1411
|
-
* </li>
|
|
1412
|
-
* </ul>
|
|
937
|
+
* <p>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:</p> <ul> <li> <p> <code>none</code> – 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 <code>none</code>, any cookies that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – Only the cookies in viewer requests that are listed in the <code>CookieNames</code> type are included in the cache key and in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>allExcept</code> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i> <b>except</b> </i> for those that are listed in the <code>CookieNames</code> type, which are not included.</p> </li> <li> <p> <code>all</code> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</p> </li> </ul>
|
|
1413
938
|
* @public
|
|
1414
939
|
*/
|
|
1415
940
|
CookieBehavior: CachePolicyCookieBehavior | undefined;
|
|
@@ -1432,29 +957,12 @@ export declare const CachePolicyHeaderBehavior: {
|
|
|
1432
957
|
*/
|
|
1433
958
|
export type CachePolicyHeaderBehavior = (typeof CachePolicyHeaderBehavior)[keyof typeof CachePolicyHeaderBehavior];
|
|
1434
959
|
/**
|
|
1435
|
-
* <p>An object that determines whether any HTTP headers (and if so, which headers) are included
|
|
1436
|
-
* in the cache key and in requests that CloudFront sends to the origin.</p>
|
|
960
|
+
* <p>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.</p>
|
|
1437
961
|
* @public
|
|
1438
962
|
*/
|
|
1439
963
|
export interface CachePolicyHeadersConfig {
|
|
1440
964
|
/**
|
|
1441
|
-
* <p>Determines whether any HTTP headers are included in the cache key and in requests that CloudFront
|
|
1442
|
-
* sends to the origin. Valid values are:</p>
|
|
1443
|
-
* <ul>
|
|
1444
|
-
* <li>
|
|
1445
|
-
* <p>
|
|
1446
|
-
* <code>none</code> – No HTTP headers are included in the cache key or in requests that CloudFront
|
|
1447
|
-
* sends to the origin. Even when this field is set to <code>none</code>, any
|
|
1448
|
-
* headers that are listed in an <code>OriginRequestPolicy</code>
|
|
1449
|
-
* <i>are</i> included in origin requests.</p>
|
|
1450
|
-
* </li>
|
|
1451
|
-
* <li>
|
|
1452
|
-
* <p>
|
|
1453
|
-
* <code>whitelist</code> – Only the HTTP headers that are listed in the <code>Headers</code>
|
|
1454
|
-
* type are included in the cache key and in requests that CloudFront sends to the
|
|
1455
|
-
* origin.</p>
|
|
1456
|
-
* </li>
|
|
1457
|
-
* </ul>
|
|
965
|
+
* <p>Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</p> <ul> <li> <p> <code>none</code> – 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 <code>none</code>, any headers that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – Only the HTTP headers that are listed in the <code>Headers</code> type are included in the cache key and in requests that CloudFront sends to the origin.</p> </li> </ul>
|
|
1458
966
|
* @public
|
|
1459
967
|
*/
|
|
1460
968
|
HeaderBehavior: CachePolicyHeaderBehavior | undefined;
|
|
@@ -1495,195 +1003,59 @@ export interface QueryStringNames {
|
|
|
1495
1003
|
Items?: string[] | undefined;
|
|
1496
1004
|
}
|
|
1497
1005
|
/**
|
|
1498
|
-
* <p>An object that determines whether any URL query strings in viewer requests (and if so, which
|
|
1499
|
-
* query strings) are included in the cache key and in requests that CloudFront sends to the
|
|
1500
|
-
* origin.</p>
|
|
1006
|
+
* <p>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.</p>
|
|
1501
1007
|
* @public
|
|
1502
1008
|
*/
|
|
1503
1009
|
export interface CachePolicyQueryStringsConfig {
|
|
1504
1010
|
/**
|
|
1505
|
-
* <p>Determines whether any URL query strings in viewer requests are included in the cache key
|
|
1506
|
-
* and in requests that CloudFront sends to the origin. Valid values are:</p>
|
|
1507
|
-
* <ul>
|
|
1508
|
-
* <li>
|
|
1509
|
-
* <p>
|
|
1510
|
-
* <code>none</code> – No query strings in viewer requests are included in the cache key or
|
|
1511
|
-
* in requests that CloudFront sends to the origin. Even when this field is set to
|
|
1512
|
-
* <code>none</code>, any query strings that are listed in an
|
|
1513
|
-
* <code>OriginRequestPolicy</code>
|
|
1514
|
-
* <i>are</i> included in origin
|
|
1515
|
-
* requests.</p>
|
|
1516
|
-
* </li>
|
|
1517
|
-
* <li>
|
|
1518
|
-
* <p>
|
|
1519
|
-
* <code>whitelist</code> – Only the query strings in viewer requests that are listed in the
|
|
1520
|
-
* <code>QueryStringNames</code> type are included in the cache key and in requests
|
|
1521
|
-
* that CloudFront sends to the origin.</p>
|
|
1522
|
-
* </li>
|
|
1523
|
-
* <li>
|
|
1524
|
-
* <p>
|
|
1525
|
-
* <code>allExcept</code> – All query strings in viewer requests are included in the cache
|
|
1526
|
-
* key and in requests that CloudFront sends to the origin, <i>
|
|
1527
|
-
* <b>except</b>
|
|
1528
|
-
* </i> those that are listed in the
|
|
1529
|
-
* <code>QueryStringNames</code> type, which are not included.</p>
|
|
1530
|
-
* </li>
|
|
1531
|
-
* <li>
|
|
1532
|
-
* <p>
|
|
1533
|
-
* <code>all</code> – All query strings in viewer requests are included in the cache key and
|
|
1534
|
-
* in requests that CloudFront sends to the origin.</p>
|
|
1535
|
-
* </li>
|
|
1536
|
-
* </ul>
|
|
1011
|
+
* <p>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:</p> <ul> <li> <p> <code>none</code> – 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 <code>none</code>, any query strings that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – Only the query strings in viewer requests that are listed in the <code>QueryStringNames</code> type are included in the cache key and in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>allExcept</code> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i> <b>except</b> </i> those that are listed in the <code>QueryStringNames</code> type, which are not included.</p> </li> <li> <p> <code>all</code> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</p> </li> </ul>
|
|
1537
1012
|
* @public
|
|
1538
1013
|
*/
|
|
1539
1014
|
QueryStringBehavior: CachePolicyQueryStringBehavior | undefined;
|
|
1540
1015
|
/**
|
|
1541
|
-
* <p>Contains the specific query strings in viewer requests that either <i>
|
|
1542
|
-
* <b>are</b>
|
|
1543
|
-
* </i> or <i>
|
|
1544
|
-
* <b>are
|
|
1545
|
-
* not</b>
|
|
1546
|
-
* </i> included in the cache key and in requests that CloudFront sends to
|
|
1547
|
-
* the origin. The behavior depends on whether the <code>QueryStringBehavior</code> field
|
|
1548
|
-
* in the <code>CachePolicyQueryStringsConfig</code> type is set to <code>whitelist</code>
|
|
1549
|
-
* (the listed query strings <i>
|
|
1550
|
-
* <b>are</b>
|
|
1551
|
-
* </i>
|
|
1552
|
-
* included) or <code>allExcept</code> (the listed query strings <i>
|
|
1553
|
-
* <b>are not</b>
|
|
1554
|
-
* </i> included, but all other query strings
|
|
1555
|
-
* are).</p>
|
|
1016
|
+
* <p>Contains the specific query strings in viewer requests that either <i> <b>are</b> </i> or <i> <b>are not</b> </i> included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the <code>QueryStringBehavior</code> field in the <code>CachePolicyQueryStringsConfig</code> type is set to <code>whitelist</code> (the listed query strings <i> <b>are</b> </i> included) or <code>allExcept</code> (the listed query strings <i> <b>are not</b> </i> included, but all other query strings are).</p>
|
|
1556
1017
|
* @public
|
|
1557
1018
|
*/
|
|
1558
1019
|
QueryStrings?: QueryStringNames | undefined;
|
|
1559
1020
|
}
|
|
1560
1021
|
/**
|
|
1561
|
-
* <p>This object determines the values that CloudFront includes in the cache key. These values
|
|
1562
|
-
* can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to
|
|
1563
|
-
* find an object in its cache that it can return to the viewer.</p>
|
|
1564
|
-
* <p>The headers, cookies, and query strings that are included in the cache key are also included
|
|
1565
|
-
* in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an
|
|
1566
|
-
* object in its cache that matches the request's cache key. If you want to send values to
|
|
1567
|
-
* the origin but <i>not</i> include them in the cache key, use
|
|
1568
|
-
* <code>OriginRequestPolicy</code>.</p>
|
|
1022
|
+
* <p>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.</p> <p>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 <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p>
|
|
1569
1023
|
* @public
|
|
1570
1024
|
*/
|
|
1571
1025
|
export interface ParametersInCacheKeyAndForwardedToOrigin {
|
|
1572
1026
|
/**
|
|
1573
|
-
* <p>A flag that can affect whether the <code>Accept-Encoding</code> HTTP header is
|
|
1574
|
-
* included in the cache key and included in requests that CloudFront sends to the origin.</p>
|
|
1575
|
-
* <p>This field is related to the <code>EnableAcceptEncodingBrotli</code> field. If one or
|
|
1576
|
-
* both of these fields is <code>true</code>
|
|
1577
|
-
* <i>and</i> the viewer request includes the <code>Accept-Encoding</code>
|
|
1578
|
-
* header, then CloudFront does the following:</p>
|
|
1579
|
-
* <ul>
|
|
1580
|
-
* <li>
|
|
1581
|
-
* <p>Normalizes the value of the viewer's <code>Accept-Encoding</code>
|
|
1582
|
-
* header</p>
|
|
1583
|
-
* </li>
|
|
1584
|
-
* <li>
|
|
1585
|
-
* <p>Includes the normalized header in the cache key</p>
|
|
1586
|
-
* </li>
|
|
1587
|
-
* <li>
|
|
1588
|
-
* <p>Includes the normalized header in the request to the origin, if a request is
|
|
1589
|
-
* necessary</p>
|
|
1590
|
-
* </li>
|
|
1591
|
-
* </ul>
|
|
1592
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the
|
|
1593
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1594
|
-
* <p>If you set this value to <code>true</code>, and this cache behavior also has an origin
|
|
1595
|
-
* request policy attached, do not include the <code>Accept-Encoding</code> header in the
|
|
1596
|
-
* origin request policy. CloudFront always includes the <code>Accept-Encoding</code> header in
|
|
1597
|
-
* origin requests when the value of this field is <code>true</code>, so including this
|
|
1598
|
-
* header in an origin request policy has no effect.</p>
|
|
1599
|
-
* <p>If both of these fields are <code>false</code>, then CloudFront treats the
|
|
1600
|
-
* <code>Accept-Encoding</code> header the same as any other HTTP header in the viewer
|
|
1601
|
-
* request. By default, it's not included in the cache key and it's not included in origin
|
|
1602
|
-
* requests. In this case, you can manually add <code>Accept-Encoding</code> to the headers
|
|
1603
|
-
* whitelist like any other HTTP header.</p>
|
|
1027
|
+
* <p>A flag that can affect whether the <code>Accept-Encoding</code> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</p> <p>This field is related to the <code>EnableAcceptEncodingBrotli</code> field. If one or both of these fields is <code>true</code> <i>and</i> the viewer request includes the <code>Accept-Encoding</code> header, then CloudFront does the following:</p> <ul> <li> <p>Normalizes the value of the viewer's <code>Accept-Encoding</code> header</p> </li> <li> <p>Includes the normalized header in the cache key</p> </li> <li> <p>Includes the normalized header in the request to the origin, if a request is necessary</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you set this value to <code>true</code>, and this cache behavior also has an origin request policy attached, do not include the <code>Accept-Encoding</code> header in the origin request policy. CloudFront always includes the <code>Accept-Encoding</code> header in origin requests when the value of this field is <code>true</code>, so including this header in an origin request policy has no effect.</p> <p>If both of these fields are <code>false</code>, then CloudFront treats the <code>Accept-Encoding</code> 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 <code>Accept-Encoding</code> to the headers whitelist like any other HTTP header.</p>
|
|
1604
1028
|
* @public
|
|
1605
1029
|
*/
|
|
1606
1030
|
EnableAcceptEncodingGzip: boolean | undefined;
|
|
1607
1031
|
/**
|
|
1608
|
-
* <p>A flag that can affect whether the <code>Accept-Encoding</code> HTTP header is
|
|
1609
|
-
* included in the cache key and included in requests that CloudFront sends to the origin.</p>
|
|
1610
|
-
* <p>This field is related to the <code>EnableAcceptEncodingGzip</code> field. If one or
|
|
1611
|
-
* both of these fields is <code>true</code>
|
|
1612
|
-
* <i>and</i> the viewer request includes the <code>Accept-Encoding</code>
|
|
1613
|
-
* header, then CloudFront does the following:</p>
|
|
1614
|
-
* <ul>
|
|
1615
|
-
* <li>
|
|
1616
|
-
* <p>Normalizes the value of the viewer's <code>Accept-Encoding</code>
|
|
1617
|
-
* header</p>
|
|
1618
|
-
* </li>
|
|
1619
|
-
* <li>
|
|
1620
|
-
* <p>Includes the normalized header in the cache key</p>
|
|
1621
|
-
* </li>
|
|
1622
|
-
* <li>
|
|
1623
|
-
* <p>Includes the normalized header in the request to the origin, if a request is
|
|
1624
|
-
* necessary</p>
|
|
1625
|
-
* </li>
|
|
1626
|
-
* </ul>
|
|
1627
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the
|
|
1628
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1629
|
-
* <p>If you set this value to <code>true</code>, and this cache behavior also has an origin
|
|
1630
|
-
* request policy attached, do not include the <code>Accept-Encoding</code> header in the
|
|
1631
|
-
* origin request policy. CloudFront always includes the <code>Accept-Encoding</code> header in
|
|
1632
|
-
* origin requests when the value of this field is <code>true</code>, so including this
|
|
1633
|
-
* header in an origin request policy has no effect.</p>
|
|
1634
|
-
* <p>If both of these fields are <code>false</code>, then CloudFront treats the
|
|
1635
|
-
* <code>Accept-Encoding</code> header the same as any other HTTP header in the viewer
|
|
1636
|
-
* request. By default, it's not included in the cache key and it's not included in origin
|
|
1637
|
-
* requests. In this case, you can manually add <code>Accept-Encoding</code> to the headers
|
|
1638
|
-
* whitelist like any other HTTP header.</p>
|
|
1032
|
+
* <p>A flag that can affect whether the <code>Accept-Encoding</code> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</p> <p>This field is related to the <code>EnableAcceptEncodingGzip</code> field. If one or both of these fields is <code>true</code> <i>and</i> the viewer request includes the <code>Accept-Encoding</code> header, then CloudFront does the following:</p> <ul> <li> <p>Normalizes the value of the viewer's <code>Accept-Encoding</code> header</p> </li> <li> <p>Includes the normalized header in the cache key</p> </li> <li> <p>Includes the normalized header in the request to the origin, if a request is necessary</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you set this value to <code>true</code>, and this cache behavior also has an origin request policy attached, do not include the <code>Accept-Encoding</code> header in the origin request policy. CloudFront always includes the <code>Accept-Encoding</code> header in origin requests when the value of this field is <code>true</code>, so including this header in an origin request policy has no effect.</p> <p>If both of these fields are <code>false</code>, then CloudFront treats the <code>Accept-Encoding</code> 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 <code>Accept-Encoding</code> to the headers whitelist like any other HTTP header.</p>
|
|
1639
1033
|
* @public
|
|
1640
1034
|
*/
|
|
1641
1035
|
EnableAcceptEncodingBrotli?: boolean | undefined;
|
|
1642
1036
|
/**
|
|
1643
|
-
* <p>An object that determines whether any HTTP headers (and if so, which headers) are included
|
|
1644
|
-
* in the cache key and in requests that CloudFront sends to the origin.</p>
|
|
1037
|
+
* <p>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.</p>
|
|
1645
1038
|
* @public
|
|
1646
1039
|
*/
|
|
1647
1040
|
HeadersConfig: CachePolicyHeadersConfig | undefined;
|
|
1648
1041
|
/**
|
|
1649
|
-
* <p>An object that determines whether any cookies in viewer requests (and if so, which cookies)
|
|
1650
|
-
* are included in the cache key and in requests that CloudFront sends to the origin.</p>
|
|
1042
|
+
* <p>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.</p>
|
|
1651
1043
|
* @public
|
|
1652
1044
|
*/
|
|
1653
1045
|
CookiesConfig: CachePolicyCookiesConfig | undefined;
|
|
1654
1046
|
/**
|
|
1655
|
-
* <p>An object that determines whether any URL query strings in viewer requests (and if so, which
|
|
1656
|
-
* query strings) are included in the cache key and in requests that CloudFront sends to the
|
|
1657
|
-
* origin.</p>
|
|
1047
|
+
* <p>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.</p>
|
|
1658
1048
|
* @public
|
|
1659
1049
|
*/
|
|
1660
1050
|
QueryStringsConfig: CachePolicyQueryStringsConfig | undefined;
|
|
1661
1051
|
}
|
|
1662
1052
|
/**
|
|
1663
|
-
* <p>A cache policy configuration.</p>
|
|
1664
|
-
* <p>This configuration determines the following:</p>
|
|
1665
|
-
* <ul>
|
|
1666
|
-
* <li>
|
|
1667
|
-
* <p>The values that CloudFront includes in the cache key. These values can include HTTP
|
|
1668
|
-
* headers, cookies, and URL query strings. CloudFront uses the cache key to find an
|
|
1669
|
-
* object in its cache that it can return to the viewer.</p>
|
|
1670
|
-
* </li>
|
|
1671
|
-
* <li>
|
|
1672
|
-
* <p>The default, minimum, and maximum time to live (TTL) values that you want
|
|
1673
|
-
* objects to stay in the CloudFront cache.</p>
|
|
1674
|
-
* </li>
|
|
1675
|
-
* </ul>
|
|
1676
|
-
* <p>The headers, cookies, and query strings that are included in the cache key are also included
|
|
1677
|
-
* in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a
|
|
1678
|
-
* valid object in its cache that matches the request's cache key. If you want to send
|
|
1679
|
-
* values to the origin but <i>not</i> include them in the cache key, use
|
|
1680
|
-
* <code>OriginRequestPolicy</code>.</p>
|
|
1053
|
+
* <p>A cache policy configuration.</p> <p>This configuration determines the following:</p> <ul> <li> <p>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.</p> </li> <li> <p>The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.</p> </li> </ul> <p>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 <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p>
|
|
1681
1054
|
* @public
|
|
1682
1055
|
*/
|
|
1683
1056
|
export interface CachePolicyConfig {
|
|
1684
1057
|
/**
|
|
1685
|
-
* <p>A comment to describe the cache policy. The comment cannot be longer than 128
|
|
1686
|
-
* characters.</p>
|
|
1058
|
+
* <p>A comment to describe the cache policy. The comment cannot be longer than 128 characters.</p>
|
|
1687
1059
|
* @public
|
|
1688
1060
|
*/
|
|
1689
1061
|
Comment?: string | undefined;
|
|
@@ -1693,67 +1065,28 @@ export interface CachePolicyConfig {
|
|
|
1693
1065
|
*/
|
|
1694
1066
|
Name: string | undefined;
|
|
1695
1067
|
/**
|
|
1696
|
-
* <p>The default amount of time, in seconds, that you want objects to stay in the CloudFront
|
|
1697
|
-
* cache before CloudFront sends another request to the origin to see if the object has been
|
|
1698
|
-
* updated. CloudFront uses this value as the object's time to live (TTL) only when the origin
|
|
1699
|
-
* does <i>not</i> send <code>Cache-Control</code> or <code>Expires</code>
|
|
1700
|
-
* headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
1701
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1702
|
-
* <p>The default value for this field is 86400 seconds (one day). If the value of
|
|
1703
|
-
* <code>MinTTL</code> is more than 86400 seconds, then the default value for this
|
|
1704
|
-
* field is the same as the value of <code>MinTTL</code>.</p>
|
|
1068
|
+
* <p>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 <i>not</i> send <code>Cache-Control</code> or <code>Expires</code> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The default value for this field is 86400 seconds (one day). If the value of <code>MinTTL</code> is more than 86400 seconds, then the default value for this field is the same as the value of <code>MinTTL</code>.</p>
|
|
1705
1069
|
* @public
|
|
1706
1070
|
*/
|
|
1707
1071
|
DefaultTTL?: number | undefined;
|
|
1708
1072
|
/**
|
|
1709
|
-
* <p>The maximum amount of time, in seconds, that objects stay in the CloudFront cache before
|
|
1710
|
-
* CloudFront sends another request to the origin to see if the object has been updated. CloudFront
|
|
1711
|
-
* uses this value only when the origin sends <code>Cache-Control</code> or
|
|
1712
|
-
* <code>Expires</code> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
1713
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1714
|
-
* <p>The default value for this field is 31536000 seconds (one year). If the value of
|
|
1715
|
-
* <code>MinTTL</code> or <code>DefaultTTL</code> is more than 31536000 seconds, then
|
|
1716
|
-
* the default value for this field is the same as the value of
|
|
1717
|
-
* <code>DefaultTTL</code>.</p>
|
|
1073
|
+
* <p>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 <code>Cache-Control</code> or <code>Expires</code> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The default value for this field is 31536000 seconds (one year). If the value of <code>MinTTL</code> or <code>DefaultTTL</code> is more than 31536000 seconds, then the default value for this field is the same as the value of <code>DefaultTTL</code>.</p>
|
|
1718
1074
|
* @public
|
|
1719
1075
|
*/
|
|
1720
1076
|
MaxTTL?: number | undefined;
|
|
1721
1077
|
/**
|
|
1722
|
-
* <p>The minimum amount of time, in seconds, that you want objects to stay in the CloudFront
|
|
1723
|
-
* cache before CloudFront sends another request to the origin to see if the object has been
|
|
1724
|
-
* updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
1725
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1078
|
+
* <p>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 <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1726
1079
|
* @public
|
|
1727
1080
|
*/
|
|
1728
1081
|
MinTTL: number | undefined;
|
|
1729
1082
|
/**
|
|
1730
|
-
* <p>The HTTP headers, cookies, and URL query strings to include in the cache key. The values
|
|
1731
|
-
* included in the cache key are also included in requests that CloudFront sends to the
|
|
1732
|
-
* origin.</p>
|
|
1083
|
+
* <p>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.</p>
|
|
1733
1084
|
* @public
|
|
1734
1085
|
*/
|
|
1735
1086
|
ParametersInCacheKeyAndForwardedToOrigin?: ParametersInCacheKeyAndForwardedToOrigin | undefined;
|
|
1736
1087
|
}
|
|
1737
1088
|
/**
|
|
1738
|
-
* <p>A cache policy.</p>
|
|
1739
|
-
* <p>When it's attached to a cache behavior, the cache policy determines the
|
|
1740
|
-
* following:</p>
|
|
1741
|
-
* <ul>
|
|
1742
|
-
* <li>
|
|
1743
|
-
* <p>The values that CloudFront includes in the cache key. These values can include HTTP
|
|
1744
|
-
* headers, cookies, and URL query strings. CloudFront uses the cache key to find an
|
|
1745
|
-
* object in its cache that it can return to the viewer.</p>
|
|
1746
|
-
* </li>
|
|
1747
|
-
* <li>
|
|
1748
|
-
* <p>The default, minimum, and maximum time to live (TTL) values that you want
|
|
1749
|
-
* objects to stay in the CloudFront cache.</p>
|
|
1750
|
-
* </li>
|
|
1751
|
-
* </ul>
|
|
1752
|
-
* <p>The headers, cookies, and query strings that are included in the cache key are also included
|
|
1753
|
-
* in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a
|
|
1754
|
-
* valid object in its cache that matches the request's cache key. If you want to send
|
|
1755
|
-
* values to the origin but <i>not</i> include them in the cache key, use
|
|
1756
|
-
* <code>OriginRequestPolicy</code>.</p>
|
|
1089
|
+
* <p>A cache policy.</p> <p>When it's attached to a cache behavior, the cache policy determines the following:</p> <ul> <li> <p>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.</p> </li> <li> <p>The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.</p> </li> </ul> <p>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 <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p>
|
|
1757
1090
|
* @public
|
|
1758
1091
|
*/
|
|
1759
1092
|
export interface CachePolicy {
|
|
@@ -1774,8 +1107,7 @@ export interface CachePolicy {
|
|
|
1774
1107
|
CachePolicyConfig: CachePolicyConfig | undefined;
|
|
1775
1108
|
}
|
|
1776
1109
|
/**
|
|
1777
|
-
* <p>A cache policy with this name already exists. You must provide a unique name. To
|
|
1778
|
-
* modify an existing cache policy, use <code>UpdateCachePolicy</code>.</p>
|
|
1110
|
+
* <p>A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use <code>UpdateCachePolicy</code>.</p>
|
|
1779
1111
|
* @public
|
|
1780
1112
|
*/
|
|
1781
1113
|
export declare class CachePolicyAlreadyExists extends __BaseException {
|
|
@@ -1788,8 +1120,7 @@ export declare class CachePolicyAlreadyExists extends __BaseException {
|
|
|
1788
1120
|
constructor(opts: __ExceptionOptionType<CachePolicyAlreadyExists, __BaseException>);
|
|
1789
1121
|
}
|
|
1790
1122
|
/**
|
|
1791
|
-
* <p>Cannot delete the cache policy because it is attached to one or more cache
|
|
1792
|
-
* behaviors.</p>
|
|
1123
|
+
* <p>Cannot delete the cache policy because it is attached to one or more cache behaviors.</p>
|
|
1793
1124
|
* @public
|
|
1794
1125
|
*/
|
|
1795
1126
|
export declare class CachePolicyInUse extends __BaseException {
|
|
@@ -1819,8 +1150,7 @@ export type CachePolicyType = (typeof CachePolicyType)[keyof typeof CachePolicyT
|
|
|
1819
1150
|
*/
|
|
1820
1151
|
export interface CachePolicySummary {
|
|
1821
1152
|
/**
|
|
1822
|
-
* <p>The type of cache policy, either <code>managed</code> (created by Amazon Web Services) or
|
|
1823
|
-
* <code>custom</code> (created in this Amazon Web Services account).</p>
|
|
1153
|
+
* <p>The type of cache policy, either <code>managed</code> (created by Amazon Web Services) or <code>custom</code> (created in this Amazon Web Services account).</p>
|
|
1824
1154
|
* @public
|
|
1825
1155
|
*/
|
|
1826
1156
|
Type: CachePolicyType | undefined;
|
|
@@ -1836,9 +1166,7 @@ export interface CachePolicySummary {
|
|
|
1836
1166
|
*/
|
|
1837
1167
|
export interface CachePolicyList {
|
|
1838
1168
|
/**
|
|
1839
|
-
* <p>If there are more items in the list than are in this response, this element is
|
|
1840
|
-
* present. It contains the value that you should use in the <code>Marker</code> field of a
|
|
1841
|
-
* subsequent request to continue listing cache policies where you left off.</p>
|
|
1169
|
+
* <p>If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the <code>Marker</code> field of a subsequent request to continue listing cache policies where you left off.</p>
|
|
1842
1170
|
* @public
|
|
1843
1171
|
*/
|
|
1844
1172
|
NextMarker?: string | undefined;
|
|
@@ -1951,38 +1279,27 @@ export declare class CNAMEAlreadyExists extends __BaseException {
|
|
|
1951
1279
|
*/
|
|
1952
1280
|
export interface CopyDistributionRequest {
|
|
1953
1281
|
/**
|
|
1954
|
-
* <p>The identifier of the primary distribution whose configuration you are copying. To get
|
|
1955
|
-
* a distribution ID, use <code>ListDistributions</code>.</p>
|
|
1282
|
+
* <p>The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use <code>ListDistributions</code>.</p>
|
|
1956
1283
|
* @public
|
|
1957
1284
|
*/
|
|
1958
1285
|
PrimaryDistributionId: string | undefined;
|
|
1959
1286
|
/**
|
|
1960
|
-
* <p>The type of distribution that your primary distribution will be copied to. The only
|
|
1961
|
-
* valid value is <code>True</code>, indicating that you are copying to a staging
|
|
1962
|
-
* distribution.</p>
|
|
1287
|
+
* <p>The type of distribution that your primary distribution will be copied to. The only valid value is <code>True</code>, indicating that you are copying to a staging distribution.</p>
|
|
1963
1288
|
* @public
|
|
1964
1289
|
*/
|
|
1965
1290
|
Staging?: boolean | undefined;
|
|
1966
1291
|
/**
|
|
1967
|
-
* <p>The version identifier of the primary distribution whose configuration you are
|
|
1968
|
-
* copying. This is the <code>ETag</code> value returned in the response to
|
|
1969
|
-
* <code>GetDistribution</code> and <code>GetDistributionConfig</code>.</p>
|
|
1292
|
+
* <p>The version identifier of the primary distribution whose configuration you are copying. This is the <code>ETag</code> value returned in the response to <code>GetDistribution</code> and <code>GetDistributionConfig</code>.</p>
|
|
1970
1293
|
* @public
|
|
1971
1294
|
*/
|
|
1972
1295
|
IfMatch?: string | undefined;
|
|
1973
1296
|
/**
|
|
1974
|
-
* <p>A value that uniquely identifies a request to create a resource. This helps to prevent
|
|
1975
|
-
* CloudFront from creating a duplicate resource if you accidentally resubmit an identical
|
|
1976
|
-
* request.</p>
|
|
1297
|
+
* <p>A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request.</p>
|
|
1977
1298
|
* @public
|
|
1978
1299
|
*/
|
|
1979
1300
|
CallerReference: string | undefined;
|
|
1980
1301
|
/**
|
|
1981
|
-
* <p>A Boolean flag to specify the state of the staging distribution when it's
|
|
1982
|
-
* created. When you set this value to <code>True</code>, the staging
|
|
1983
|
-
* distribution is enabled. When you set this value to <code>False</code>, the
|
|
1984
|
-
* staging distribution is disabled.</p>
|
|
1985
|
-
* <p>If you omit this field, the default value is <code>True</code>.</p>
|
|
1302
|
+
* <p>A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to <code>True</code>, the staging distribution is enabled. When you set this value to <code>False</code>, the staging distribution is disabled.</p> <p>If you omit this field, the default value is <code>True</code>.</p>
|
|
1986
1303
|
* @public
|
|
1987
1304
|
*/
|
|
1988
1305
|
Enabled?: boolean | undefined;
|
|
@@ -2000,286 +1317,114 @@ export declare const ConnectionMode: {
|
|
|
2000
1317
|
*/
|
|
2001
1318
|
export type ConnectionMode = (typeof ConnectionMode)[keyof typeof ConnectionMode];
|
|
2002
1319
|
/**
|
|
2003
|
-
* <p>A complex type that controls:</p>
|
|
2004
|
-
* <ul>
|
|
2005
|
-
* <li>
|
|
2006
|
-
* <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom
|
|
2007
|
-
* error messages before returning the response to the viewer.</p>
|
|
2008
|
-
* </li>
|
|
2009
|
-
* <li>
|
|
2010
|
-
* <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p>
|
|
2011
|
-
* </li>
|
|
2012
|
-
* </ul>
|
|
2013
|
-
* <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing
|
|
2014
|
-
* Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1320
|
+
* <p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2015
1321
|
* @public
|
|
2016
1322
|
*/
|
|
2017
1323
|
export interface CustomErrorResponse {
|
|
2018
1324
|
/**
|
|
2019
|
-
* <p>The HTTP status code for which you want to specify a custom error page and/or a
|
|
2020
|
-
* caching duration.</p>
|
|
1325
|
+
* <p>The HTTP status code for which you want to specify a custom error page and/or a caching duration.</p>
|
|
2021
1326
|
* @public
|
|
2022
1327
|
*/
|
|
2023
1328
|
ErrorCode: number | undefined;
|
|
2024
1329
|
/**
|
|
2025
|
-
* <p>The path to the custom error page that you want CloudFront to return to a viewer when your
|
|
2026
|
-
* origin returns the HTTP status code specified by <code>ErrorCode</code>, for example,
|
|
2027
|
-
* <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and
|
|
2028
|
-
* your custom error pages in different locations, your distribution must include a cache
|
|
2029
|
-
* behavior for which the following is true:</p>
|
|
2030
|
-
* <ul>
|
|
2031
|
-
* <li>
|
|
2032
|
-
* <p>The value of <code>PathPattern</code> matches the path to your custom error
|
|
2033
|
-
* messages. For example, suppose you saved custom error pages for 4xx errors in an
|
|
2034
|
-
* Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution
|
|
2035
|
-
* must include a cache behavior for which the path pattern routes requests for
|
|
2036
|
-
* your custom error pages to that location, for example,
|
|
2037
|
-
* <code>/4xx-errors/*</code>.</p>
|
|
2038
|
-
* </li>
|
|
2039
|
-
* <li>
|
|
2040
|
-
* <p>The value of <code>TargetOriginId</code> specifies the value of the
|
|
2041
|
-
* <code>ID</code> element for the origin that contains your custom error
|
|
2042
|
-
* pages.</p>
|
|
2043
|
-
* </li>
|
|
2044
|
-
* </ul>
|
|
2045
|
-
* <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a
|
|
2046
|
-
* value for <code>ResponseCode</code>.</p>
|
|
2047
|
-
* <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom
|
|
2048
|
-
* error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get
|
|
2049
|
-
* the files that you want to return to viewers because the origin server is
|
|
2050
|
-
* unavailable.</p>
|
|
1330
|
+
* <p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>.</p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>
|
|
2051
1331
|
* @public
|
|
2052
1332
|
*/
|
|
2053
1333
|
ResponsePagePath?: string | undefined;
|
|
2054
1334
|
/**
|
|
2055
|
-
* <p>The HTTP status code that you want CloudFront to return to the viewer along with the custom
|
|
2056
|
-
* error page. There are a variety of reasons that you might want CloudFront to return a status
|
|
2057
|
-
* code different from the status code that your origin returned to CloudFront, for
|
|
2058
|
-
* example:</p>
|
|
2059
|
-
* <ul>
|
|
2060
|
-
* <li>
|
|
2061
|
-
* <p>Some Internet devices (some firewalls and corporate proxies, for example)
|
|
2062
|
-
* intercept HTTP 4xx and 5xx and prevent the response from being returned to the
|
|
2063
|
-
* viewer. If you substitute <code>200</code>, the response typically won't be
|
|
2064
|
-
* intercepted.</p>
|
|
2065
|
-
* </li>
|
|
2066
|
-
* <li>
|
|
2067
|
-
* <p>If you don't care about distinguishing among different client errors or server
|
|
2068
|
-
* errors, you can specify <code>400</code> or <code>500</code> as the
|
|
2069
|
-
* <code>ResponseCode</code> for all 4xx or 5xx errors.</p>
|
|
2070
|
-
* </li>
|
|
2071
|
-
* <li>
|
|
2072
|
-
* <p>You might want to return a <code>200</code> status code (OK) and static
|
|
2073
|
-
* website so your customers don't know that your website is down.</p>
|
|
2074
|
-
* </li>
|
|
2075
|
-
* </ul>
|
|
2076
|
-
* <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value
|
|
2077
|
-
* for <code>ResponsePagePath</code>.</p>
|
|
1335
|
+
* <p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>.</p>
|
|
2078
1336
|
* @public
|
|
2079
1337
|
*/
|
|
2080
1338
|
ResponseCode?: string | undefined;
|
|
2081
1339
|
/**
|
|
2082
|
-
* <p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status
|
|
2083
|
-
* code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront
|
|
2084
|
-
* queries your origin to see whether the problem that caused the error has been resolved
|
|
2085
|
-
* and the requested object is now available.</p>
|
|
2086
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing
|
|
2087
|
-
* Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1340
|
+
* <p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2088
1341
|
* @public
|
|
2089
1342
|
*/
|
|
2090
1343
|
ErrorCachingMinTTL?: number | undefined;
|
|
2091
1344
|
}
|
|
2092
1345
|
/**
|
|
2093
|
-
* <p>A complex type that controls:</p>
|
|
2094
|
-
* <ul>
|
|
2095
|
-
* <li>
|
|
2096
|
-
* <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom
|
|
2097
|
-
* error messages before returning the response to the viewer.</p>
|
|
2098
|
-
* </li>
|
|
2099
|
-
* <li>
|
|
2100
|
-
* <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p>
|
|
2101
|
-
* </li>
|
|
2102
|
-
* </ul>
|
|
2103
|
-
* <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing
|
|
2104
|
-
* Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1346
|
+
* <p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2105
1347
|
* @public
|
|
2106
1348
|
*/
|
|
2107
1349
|
export interface CustomErrorResponses {
|
|
2108
1350
|
/**
|
|
2109
|
-
* <p>The number of HTTP status codes for which you want to specify a custom error page
|
|
2110
|
-
* and/or a caching duration. If <code>Quantity</code> is <code>0</code>, you can omit
|
|
2111
|
-
* <code>Items</code>.</p>
|
|
1351
|
+
* <p>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>
|
|
2112
1352
|
* @public
|
|
2113
1353
|
*/
|
|
2114
1354
|
Quantity: number | undefined;
|
|
2115
1355
|
/**
|
|
2116
|
-
* <p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP
|
|
2117
|
-
* status code for which you want to specify a custom error page and/or a caching duration.
|
|
2118
|
-
* </p>
|
|
1356
|
+
* <p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </p>
|
|
2119
1357
|
* @public
|
|
2120
1358
|
*/
|
|
2121
1359
|
Items?: CustomErrorResponse[] | undefined;
|
|
2122
1360
|
}
|
|
2123
1361
|
/**
|
|
2124
|
-
* <p>A complex type that describes the default cache behavior if you don't specify a
|
|
2125
|
-
* <code>CacheBehavior</code> element or if request URLs don't match any of the values
|
|
2126
|
-
* of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create
|
|
2127
|
-
* exactly one default cache behavior.</p>
|
|
1362
|
+
* <p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if request URLs don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>
|
|
2128
1363
|
* @public
|
|
2129
1364
|
*/
|
|
2130
1365
|
export interface DefaultCacheBehavior {
|
|
2131
1366
|
/**
|
|
2132
|
-
* <p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to
|
|
2133
|
-
* when they use the default cache behavior.</p>
|
|
1367
|
+
* <p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when they use the default cache behavior.</p>
|
|
2134
1368
|
* @public
|
|
2135
1369
|
*/
|
|
2136
1370
|
TargetOriginId: string | undefined;
|
|
2137
1371
|
/**
|
|
2138
|
-
* <important>
|
|
2139
|
-
* <p>We recommend using <code>TrustedKeyGroups</code> instead of
|
|
2140
|
-
* <code>TrustedSigners</code>.</p>
|
|
2141
|
-
* </important>
|
|
2142
|
-
* <p>A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or
|
|
2143
|
-
* signed cookies.</p>
|
|
2144
|
-
* <p>When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed
|
|
2145
|
-
* cookies for all requests that match the cache behavior. The URLs or cookies must be
|
|
2146
|
-
* signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The
|
|
2147
|
-
* signed URL or cookie contains information about which public key CloudFront should use to
|
|
2148
|
-
* verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the
|
|
2149
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1372
|
+
* <important> <p>We recommend using <code>TrustedKeyGroups</code> instead of <code>TrustedSigners</code>.</p> </important> <p>A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.</p> <p>When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2150
1373
|
* @public
|
|
2151
1374
|
*/
|
|
2152
1375
|
TrustedSigners?: TrustedSigners | undefined;
|
|
2153
1376
|
/**
|
|
2154
|
-
* <p>A list of key groups that CloudFront can use to validate signed URLs or signed
|
|
2155
|
-
* cookies.</p>
|
|
2156
|
-
* <p>When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed
|
|
2157
|
-
* cookies for all requests that match the cache behavior. The URLs or cookies must be
|
|
2158
|
-
* signed with a private key whose corresponding public key is in the key group. The signed
|
|
2159
|
-
* URL or cookie contains information about which public key CloudFront should use to verify the
|
|
2160
|
-
* signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the
|
|
2161
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1377
|
+
* <p>A list of key groups that CloudFront can use to validate signed URLs or signed cookies.</p> <p>When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2162
1378
|
* @public
|
|
2163
1379
|
*/
|
|
2164
1380
|
TrustedKeyGroups?: TrustedKeyGroups | undefined;
|
|
2165
1381
|
/**
|
|
2166
|
-
* <p>The protocol that viewers can use to access the files in the origin specified by
|
|
2167
|
-
* <code>TargetOriginId</code> when a request matches the path pattern in
|
|
2168
|
-
* <code>PathPattern</code>. You can specify the following options:</p>
|
|
2169
|
-
* <ul>
|
|
2170
|
-
* <li>
|
|
2171
|
-
* <p>
|
|
2172
|
-
* <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p>
|
|
2173
|
-
* </li>
|
|
2174
|
-
* <li>
|
|
2175
|
-
* <p>
|
|
2176
|
-
* <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront
|
|
2177
|
-
* returns an HTTP status code of 301 (Moved Permanently) to the viewer along with
|
|
2178
|
-
* the HTTPS URL. The viewer then resubmits the request using the new URL.</p>
|
|
2179
|
-
* </li>
|
|
2180
|
-
* <li>
|
|
2181
|
-
* <p>
|
|
2182
|
-
* <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an
|
|
2183
|
-
* HTTP status code of 403 (Forbidden).</p>
|
|
2184
|
-
* </li>
|
|
2185
|
-
* </ul>
|
|
2186
|
-
* <p>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the
|
|
2187
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2188
|
-
* <note>
|
|
2189
|
-
* <p>The only way to guarantee that viewers retrieve an object that was fetched from
|
|
2190
|
-
* the origin using HTTPS is never to use any other protocol to fetch the object. If
|
|
2191
|
-
* you have recently changed from HTTP to HTTPS, we recommend that you clear your
|
|
2192
|
-
* objects' cache because cached objects are protocol agnostic. That means that an edge
|
|
2193
|
-
* location will return an object from the cache regardless of whether the current
|
|
2194
|
-
* request protocol matches the protocol used previously. For more information, see
|
|
2195
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache
|
|
2196
|
-
* Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2197
|
-
* </note>
|
|
1382
|
+
* <p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>
|
|
2198
1383
|
* @public
|
|
2199
1384
|
*/
|
|
2200
1385
|
ViewerProtocolPolicy: ViewerProtocolPolicy | undefined;
|
|
2201
1386
|
/**
|
|
2202
|
-
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your
|
|
2203
|
-
* Amazon S3 bucket or your custom origin. There are three choices:</p>
|
|
2204
|
-
* <ul>
|
|
2205
|
-
* <li>
|
|
2206
|
-
* <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p>
|
|
2207
|
-
* </li>
|
|
2208
|
-
* <li>
|
|
2209
|
-
* <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and
|
|
2210
|
-
* <code>OPTIONS</code> requests.</p>
|
|
2211
|
-
* </li>
|
|
2212
|
-
* <li>
|
|
2213
|
-
* <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and
|
|
2214
|
-
* <code>DELETE</code> requests.</p>
|
|
2215
|
-
* </li>
|
|
2216
|
-
* </ul>
|
|
2217
|
-
* <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or
|
|
2218
|
-
* to your custom origin so users can't perform operations that you don't want them to. For
|
|
2219
|
-
* example, you might not want users to have permissions to delete objects from your
|
|
2220
|
-
* origin.</p>
|
|
1387
|
+
* <p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>
|
|
2221
1388
|
* @public
|
|
2222
1389
|
*/
|
|
2223
1390
|
AllowedMethods?: AllowedMethods | undefined;
|
|
2224
1391
|
/**
|
|
2225
|
-
* <p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming
|
|
2226
|
-
* format using the origin that is associated with this cache behavior. If so, specify
|
|
2227
|
-
* <code>true</code>; if not, specify <code>false</code>. If you specify
|
|
2228
|
-
* <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other
|
|
2229
|
-
* content using this cache behavior if the content matches the value of
|
|
2230
|
-
* <code>PathPattern</code>.</p>
|
|
1392
|
+
* <p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>.</p>
|
|
2231
1393
|
* @public
|
|
2232
1394
|
*/
|
|
2233
1395
|
SmoothStreaming?: boolean | undefined;
|
|
2234
1396
|
/**
|
|
2235
|
-
* <p>Whether you want CloudFront to automatically compress certain files for this cache behavior.
|
|
2236
|
-
* If so, specify <code>true</code>; if not, specify <code>false</code>. For more
|
|
2237
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving
|
|
2238
|
-
* Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1397
|
+
* <p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2239
1398
|
* @public
|
|
2240
1399
|
*/
|
|
2241
1400
|
Compress?: boolean | undefined;
|
|
2242
1401
|
/**
|
|
2243
|
-
* <p>A complex type that contains zero or more Lambda@Edge function associations for a
|
|
2244
|
-
* cache behavior.</p>
|
|
1402
|
+
* <p>A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.</p>
|
|
2245
1403
|
* @public
|
|
2246
1404
|
*/
|
|
2247
1405
|
LambdaFunctionAssociations?: LambdaFunctionAssociations | undefined;
|
|
2248
1406
|
/**
|
|
2249
|
-
* <p>A list of CloudFront functions that are associated with this cache behavior. Your functions
|
|
2250
|
-
* must be published to the <code>LIVE</code> stage to associate them with a cache
|
|
2251
|
-
* behavior.</p>
|
|
1407
|
+
* <p>A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the <code>LIVE</code> stage to associate them with a cache behavior.</p>
|
|
2252
1408
|
* @public
|
|
2253
1409
|
*/
|
|
2254
1410
|
FunctionAssociations?: FunctionAssociations | undefined;
|
|
2255
1411
|
/**
|
|
2256
|
-
* <p>The value of <code>ID</code> for the field-level encryption configuration that you
|
|
2257
|
-
* want CloudFront to use for encrypting specific fields of data for the default cache
|
|
2258
|
-
* behavior.</p>
|
|
1412
|
+
* <p>The value of <code>ID</code> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.</p>
|
|
2259
1413
|
* @public
|
|
2260
1414
|
*/
|
|
2261
1415
|
FieldLevelEncryptionId?: string | undefined;
|
|
2262
1416
|
/**
|
|
2263
|
-
* <p>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to
|
|
2264
|
-
* this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the
|
|
2265
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1417
|
+
* <p>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2266
1418
|
* @public
|
|
2267
1419
|
*/
|
|
2268
1420
|
RealtimeLogConfigArn?: string | undefined;
|
|
2269
1421
|
/**
|
|
2270
|
-
* <p>The unique identifier of the cache policy that is attached to the default cache
|
|
2271
|
-
* behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
2272
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2273
|
-
* <p>A <code>DefaultCacheBehavior</code> must include either a <code>CachePolicyId</code>
|
|
2274
|
-
* or <code>ForwardedValues</code>. We recommend that you use a
|
|
2275
|
-
* <code>CachePolicyId</code>.</p>
|
|
1422
|
+
* <p>The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>DefaultCacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p>
|
|
2276
1423
|
* @public
|
|
2277
1424
|
*/
|
|
2278
1425
|
CachePolicyId?: string | undefined;
|
|
2279
1426
|
/**
|
|
2280
|
-
* <p>The unique identifier of the origin request policy that is attached to the default
|
|
2281
|
-
* cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the
|
|
2282
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1427
|
+
* <p>The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2283
1428
|
* @public
|
|
2284
1429
|
*/
|
|
2285
1430
|
OriginRequestPolicyId?: string | undefined;
|
|
@@ -2294,68 +1439,28 @@ export interface DefaultCacheBehavior {
|
|
|
2294
1439
|
*/
|
|
2295
1440
|
GrpcConfig?: GrpcConfig | undefined;
|
|
2296
1441
|
/**
|
|
2297
|
-
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
|
|
2298
|
-
* request policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the
|
|
2299
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2300
|
-
* <p>If you want to include values in the cache key, use a cache policy. For more
|
|
2301
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
2302
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2303
|
-
* <p>If you want to send values to the origin but not include them in the cache key, use an
|
|
2304
|
-
* origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the
|
|
2305
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2306
|
-
* <p>A <code>DefaultCacheBehavior</code> must include either a <code>CachePolicyId</code>
|
|
2307
|
-
* or <code>ForwardedValues</code>. We recommend that you use a
|
|
2308
|
-
* <code>CachePolicyId</code>.</p>
|
|
2309
|
-
* <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP
|
|
2310
|
-
* headers.</p>
|
|
1442
|
+
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>DefaultCacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>
|
|
2311
1443
|
*
|
|
2312
1444
|
* @deprecated
|
|
2313
1445
|
* @public
|
|
2314
1446
|
*/
|
|
2315
1447
|
ForwardedValues?: ForwardedValues | undefined;
|
|
2316
1448
|
/**
|
|
2317
|
-
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a
|
|
2318
|
-
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
2319
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2320
|
-
* <p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
2321
|
-
* forwards another request to your origin to determine whether the object has been
|
|
2322
|
-
* updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long
|
|
2323
|
-
* Content Stays in an Edge Cache (Expiration)</a> in the
|
|
2324
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2325
|
-
* <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to
|
|
2326
|
-
* forward all headers to your origin (under <code>Headers</code>, if you specify
|
|
2327
|
-
* <code>1</code> for <code>Quantity</code> and <code>*</code> for
|
|
2328
|
-
* <code>Name</code>).</p>
|
|
1449
|
+
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>
|
|
2329
1450
|
*
|
|
2330
1451
|
* @deprecated
|
|
2331
1452
|
* @public
|
|
2332
1453
|
*/
|
|
2333
1454
|
MinTTL?: number | undefined;
|
|
2334
1455
|
/**
|
|
2335
|
-
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field
|
|
2336
|
-
* in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
2337
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2338
|
-
* <p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
2339
|
-
* forwards another request to your origin to determine whether the object has been
|
|
2340
|
-
* updated. The value that you specify applies only when your origin does not add HTTP
|
|
2341
|
-
* headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>,
|
|
2342
|
-
* and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
2343
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1456
|
+
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2344
1457
|
*
|
|
2345
1458
|
* @deprecated
|
|
2346
1459
|
* @public
|
|
2347
1460
|
*/
|
|
2348
1461
|
DefaultTTL?: number | undefined;
|
|
2349
1462
|
/**
|
|
2350
|
-
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a
|
|
2351
|
-
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
|
|
2352
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2353
|
-
* <p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront
|
|
2354
|
-
* forwards another request to your origin to determine whether the object has been
|
|
2355
|
-
* updated. The value that you specify applies only when your origin adds HTTP headers such
|
|
2356
|
-
* as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and
|
|
2357
|
-
* <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the
|
|
2358
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1463
|
+
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2359
1464
|
*
|
|
2360
1465
|
* @deprecated
|
|
2361
1466
|
* @public
|
|
@@ -2377,59 +1482,33 @@ export declare const HttpVersion: {
|
|
|
2377
1482
|
*/
|
|
2378
1483
|
export type HttpVersion = (typeof HttpVersion)[keyof typeof HttpVersion];
|
|
2379
1484
|
/**
|
|
2380
|
-
* <p>A complex type that specifies whether access logs are written for the distribution.</p>
|
|
2381
|
-
* <note>
|
|
2382
|
-
* <p>If you already enabled standard logging (legacy) and you want to enable standard logging
|
|
2383
|
-
* (v2) to send your access logs to Amazon S3, we recommend that you specify a
|
|
2384
|
-
* <i>different</i> Amazon S3 bucket or use a <i>separate
|
|
2385
|
-
* path</i> in the same bucket (for example, use a log prefix or
|
|
2386
|
-
* partitioning). This helps you keep track of which log files are associated with
|
|
2387
|
-
* which logging subscription and prevents log files from overwriting each other. For
|
|
2388
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html">Standard logging (access logs)</a> in the
|
|
2389
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2390
|
-
* </note>
|
|
1485
|
+
* <p>A complex type that specifies whether access logs are written for the distribution.</p> <note> <p>If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a <i>different</i> Amazon S3 bucket or use a <i>separate path</i> in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html">Standard logging (access logs)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>
|
|
2391
1486
|
* @public
|
|
2392
1487
|
*/
|
|
2393
1488
|
export interface LoggingConfig {
|
|
2394
1489
|
/**
|
|
2395
|
-
* <p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to
|
|
2396
|
-
* enable logging when you create a distribution or if you want to disable logging for an
|
|
2397
|
-
* existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify
|
|
2398
|
-
* empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify
|
|
2399
|
-
* <code>false</code> for <code>Enabled</code> but you specify values for
|
|
2400
|
-
* <code>Bucket</code> and <code>prefix</code>, the values are automatically
|
|
2401
|
-
* deleted.</p>
|
|
1490
|
+
* <p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>prefix</code>, the values are automatically deleted.</p>
|
|
2402
1491
|
* @public
|
|
2403
1492
|
*/
|
|
2404
1493
|
Enabled?: boolean | undefined;
|
|
2405
1494
|
/**
|
|
2406
|
-
* <p>Specifies whether you want CloudFront to include cookies in access logs, specify
|
|
2407
|
-
* <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies
|
|
2408
|
-
* in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for
|
|
2409
|
-
* this distribution. If you don't want to include cookies when you create a distribution
|
|
2410
|
-
* or if you want to disable include cookies for an existing distribution, specify
|
|
2411
|
-
* <code>false</code> for <code>IncludeCookies</code>.</p>
|
|
1495
|
+
* <p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>
|
|
2412
1496
|
* @public
|
|
2413
1497
|
*/
|
|
2414
1498
|
IncludeCookies?: boolean | undefined;
|
|
2415
1499
|
/**
|
|
2416
|
-
* <p>The Amazon S3 bucket to store the access logs in, for example,
|
|
2417
|
-
* <code>amzn-s3-demo-bucket.s3.amazonaws.com</code>.</p>
|
|
1500
|
+
* <p>The Amazon S3 bucket to store the access logs in, for example, <code>amzn-s3-demo-bucket.s3.amazonaws.com</code>.</p>
|
|
2418
1501
|
* @public
|
|
2419
1502
|
*/
|
|
2420
1503
|
Bucket?: string | undefined;
|
|
2421
1504
|
/**
|
|
2422
|
-
* <p>An optional string that you want CloudFront to prefix to the access log
|
|
2423
|
-
* <code>filenames</code> for this distribution, for example, <code>myprefix/</code>.
|
|
2424
|
-
* If you want to enable logging, but you don't want to specify a prefix, you still must
|
|
2425
|
-
* include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>
|
|
1505
|
+
* <p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>
|
|
2426
1506
|
* @public
|
|
2427
1507
|
*/
|
|
2428
1508
|
Prefix?: string | undefined;
|
|
2429
1509
|
}
|
|
2430
1510
|
/**
|
|
2431
|
-
* <p>A complex data type for the status codes that you specify that, when returned by a
|
|
2432
|
-
* primary origin, trigger CloudFront to failover to a second origin.</p>
|
|
1511
|
+
* <p>A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.</p>
|
|
2433
1512
|
* @public
|
|
2434
1513
|
*/
|
|
2435
1514
|
export interface StatusCodes {
|
|
@@ -2445,9 +1524,7 @@ export interface StatusCodes {
|
|
|
2445
1524
|
Items: number[] | undefined;
|
|
2446
1525
|
}
|
|
2447
1526
|
/**
|
|
2448
|
-
* <p>A complex data type that includes information about the failover criteria for an
|
|
2449
|
-
* origin group, including the status codes for which CloudFront will failover from the
|
|
2450
|
-
* primary origin to the second origin.</p>
|
|
1527
|
+
* <p>A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.</p>
|
|
2451
1528
|
* @public
|
|
2452
1529
|
*/
|
|
2453
1530
|
export interface OriginGroupFailoverCriteria {
|
|
@@ -2497,12 +1574,7 @@ export declare const OriginGroupSelectionCriteria: {
|
|
|
2497
1574
|
*/
|
|
2498
1575
|
export type OriginGroupSelectionCriteria = (typeof OriginGroupSelectionCriteria)[keyof typeof OriginGroupSelectionCriteria];
|
|
2499
1576
|
/**
|
|
2500
|
-
* <p>An origin group includes two origins (a primary origin and a secondary origin to failover
|
|
2501
|
-
* to) and a failover criteria that you specify. You create an origin group to support
|
|
2502
|
-
* origin failover in CloudFront. When you create or update a distribution, you can specify the
|
|
2503
|
-
* origin group instead of a single origin, and CloudFront will failover from the primary origin
|
|
2504
|
-
* to the secondary origin under the failover conditions that you've chosen.</p>
|
|
2505
|
-
* <p>Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.</p>
|
|
1577
|
+
* <p>An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.</p> <p>Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.</p>
|
|
2506
1578
|
* @public
|
|
2507
1579
|
*/
|
|
2508
1580
|
export interface OriginGroup {
|
|
@@ -2512,8 +1584,7 @@ export interface OriginGroup {
|
|
|
2512
1584
|
*/
|
|
2513
1585
|
Id: string | undefined;
|
|
2514
1586
|
/**
|
|
2515
|
-
* <p>A complex type that contains information about the failover criteria for an origin
|
|
2516
|
-
* group.</p>
|
|
1587
|
+
* <p>A complex type that contains information about the failover criteria for an origin group.</p>
|
|
2517
1588
|
* @public
|
|
2518
1589
|
*/
|
|
2519
1590
|
FailoverCriteria: OriginGroupFailoverCriteria | undefined;
|
|
@@ -2523,8 +1594,7 @@ export interface OriginGroup {
|
|
|
2523
1594
|
*/
|
|
2524
1595
|
Members: OriginGroupMembers | undefined;
|
|
2525
1596
|
/**
|
|
2526
|
-
* <p>The selection criteria for the origin group. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating">Create an origin group</a> in the <i>Amazon CloudFront
|
|
2527
|
-
* Developer Guide</i>.</p>
|
|
1597
|
+
* <p>The selection criteria for the origin group. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating">Create an origin group</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2528
1598
|
* @public
|
|
2529
1599
|
*/
|
|
2530
1600
|
SelectionCriteria?: OriginGroupSelectionCriteria | undefined;
|
|
@@ -2546,22 +1616,17 @@ export interface OriginGroups {
|
|
|
2546
1616
|
Items?: OriginGroup[] | undefined;
|
|
2547
1617
|
}
|
|
2548
1618
|
/**
|
|
2549
|
-
* <p>A complex type that contains <code>HeaderName</code> and <code>HeaderValue</code>
|
|
2550
|
-
* elements, if any, for this distribution.</p>
|
|
1619
|
+
* <p>A complex type that contains <code>HeaderName</code> and <code>HeaderValue</code> elements, if any, for this distribution.</p>
|
|
2551
1620
|
* @public
|
|
2552
1621
|
*/
|
|
2553
1622
|
export interface OriginCustomHeader {
|
|
2554
1623
|
/**
|
|
2555
|
-
* <p>The name of a header that you want CloudFront to send to your origin. For more information,
|
|
2556
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html">Adding
|
|
2557
|
-
* Custom Headers to Origin Requests</a> in the <i>
|
|
2558
|
-
* Amazon CloudFront Developer Guide</i>.</p>
|
|
1624
|
+
* <p>The name of a header that you want CloudFront to send to your origin. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html">Adding Custom Headers to Origin Requests</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>
|
|
2559
1625
|
* @public
|
|
2560
1626
|
*/
|
|
2561
1627
|
HeaderName: string | undefined;
|
|
2562
1628
|
/**
|
|
2563
|
-
* <p>The value for the header that you specified in the <code>HeaderName</code>
|
|
2564
|
-
* field.</p>
|
|
1629
|
+
* <p>The value for the header that you specified in the <code>HeaderName</code> field.</p>
|
|
2565
1630
|
* @public
|
|
2566
1631
|
*/
|
|
2567
1632
|
HeaderValue: string | undefined;
|
|
@@ -2577,10 +1642,7 @@ export interface CustomHeaders {
|
|
|
2577
1642
|
*/
|
|
2578
1643
|
Quantity: number | undefined;
|
|
2579
1644
|
/**
|
|
2580
|
-
* <p>
|
|
2581
|
-
* <b>Optional</b>: A list that contains one
|
|
2582
|
-
* <code>OriginCustomHeader</code> element for each custom header that you want CloudFront to
|
|
2583
|
-
* forward to the origin. If Quantity is <code>0</code>, omit <code>Items</code>.</p>
|
|
1645
|
+
* <p> <b>Optional</b>: A list that contains one <code>OriginCustomHeader</code> element for each custom header that you want CloudFront to forward to the origin. If Quantity is <code>0</code>, omit <code>Items</code>.</p>
|
|
2584
1646
|
* @public
|
|
2585
1647
|
*/
|
|
2586
1648
|
Items?: OriginCustomHeader[] | undefined;
|
|
@@ -2613,14 +1675,12 @@ export declare const SslProtocol: {
|
|
|
2613
1675
|
*/
|
|
2614
1676
|
export type SslProtocol = (typeof SslProtocol)[keyof typeof SslProtocol];
|
|
2615
1677
|
/**
|
|
2616
|
-
* <p>A complex type that contains information about the SSL/TLS protocols that CloudFront can use
|
|
2617
|
-
* when establishing an HTTPS connection with your origin.</p>
|
|
1678
|
+
* <p>A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.</p>
|
|
2618
1679
|
* @public
|
|
2619
1680
|
*/
|
|
2620
1681
|
export interface OriginSslProtocols {
|
|
2621
1682
|
/**
|
|
2622
|
-
* <p>The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing
|
|
2623
|
-
* an HTTPS connection with this origin.</p>
|
|
1683
|
+
* <p>The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.</p>
|
|
2624
1684
|
* @public
|
|
2625
1685
|
*/
|
|
2626
1686
|
Quantity: number | undefined;
|
|
@@ -2631,140 +1691,64 @@ export interface OriginSslProtocols {
|
|
|
2631
1691
|
Items: SslProtocol[] | undefined;
|
|
2632
1692
|
}
|
|
2633
1693
|
/**
|
|
2634
|
-
* <p>A custom origin. A custom origin is any origin that is <i>not</i> an
|
|
2635
|
-
* Amazon S3 bucket, with one exception. An Amazon S3 bucket that is <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">configured with
|
|
2636
|
-
* static website hosting</a>
|
|
2637
|
-
* <i>is</i> a custom origin.</p>
|
|
1694
|
+
* <p>A custom origin. A custom origin is any origin that is <i>not</i> an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">configured with static website hosting</a> <i>is</i> a custom origin.</p>
|
|
2638
1695
|
* @public
|
|
2639
1696
|
*/
|
|
2640
1697
|
export interface CustomOriginConfig {
|
|
2641
1698
|
/**
|
|
2642
|
-
* <p>The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the
|
|
2643
|
-
* origin listens on.</p>
|
|
1699
|
+
* <p>The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.</p>
|
|
2644
1700
|
* @public
|
|
2645
1701
|
*/
|
|
2646
1702
|
HTTPPort: number | undefined;
|
|
2647
1703
|
/**
|
|
2648
|
-
* <p>The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that
|
|
2649
|
-
* the origin listens on.</p>
|
|
1704
|
+
* <p>The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.</p>
|
|
2650
1705
|
* @public
|
|
2651
1706
|
*/
|
|
2652
1707
|
HTTPSPort: number | undefined;
|
|
2653
1708
|
/**
|
|
2654
|
-
* <p>Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid
|
|
2655
|
-
* values are:</p>
|
|
2656
|
-
* <ul>
|
|
2657
|
-
* <li>
|
|
2658
|
-
* <p>
|
|
2659
|
-
* <code>http-only</code> – CloudFront always uses HTTP to connect to the
|
|
2660
|
-
* origin.</p>
|
|
2661
|
-
* </li>
|
|
2662
|
-
* <li>
|
|
2663
|
-
* <p>
|
|
2664
|
-
* <code>match-viewer</code> – CloudFront connects to the origin using the same
|
|
2665
|
-
* protocol that the viewer used to connect to CloudFront.</p>
|
|
2666
|
-
* </li>
|
|
2667
|
-
* <li>
|
|
2668
|
-
* <p>
|
|
2669
|
-
* <code>https-only</code> – CloudFront always uses HTTPS to connect to the
|
|
2670
|
-
* origin.</p>
|
|
2671
|
-
* </li>
|
|
2672
|
-
* </ul>
|
|
1709
|
+
* <p>Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:</p> <ul> <li> <p> <code>http-only</code> – CloudFront always uses HTTP to connect to the origin.</p> </li> <li> <p> <code>match-viewer</code> – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.</p> </li> <li> <p> <code>https-only</code> – CloudFront always uses HTTPS to connect to the origin.</p> </li> </ul>
|
|
2673
1710
|
* @public
|
|
2674
1711
|
*/
|
|
2675
1712
|
OriginProtocolPolicy: OriginProtocolPolicy | undefined;
|
|
2676
1713
|
/**
|
|
2677
|
-
* <p>Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin
|
|
2678
|
-
* over HTTPS. Valid values include <code>SSLv3</code>, <code>TLSv1</code>,
|
|
2679
|
-
* <code>TLSv1.1</code>, and <code>TLSv1.2</code>.</p>
|
|
2680
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols">Minimum Origin SSL Protocol</a> in the
|
|
2681
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1714
|
+
* <p>Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include <code>SSLv3</code>, <code>TLSv1</code>, <code>TLSv1.1</code>, and <code>TLSv1.2</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols">Minimum Origin SSL Protocol</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2682
1715
|
* @public
|
|
2683
1716
|
*/
|
|
2684
1717
|
OriginSslProtocols?: OriginSslProtocols | undefined;
|
|
2685
1718
|
/**
|
|
2686
|
-
* <p>Specifies how long, in seconds, CloudFront waits for a response from the origin. This is
|
|
2687
|
-
* also known as the <i>origin response timeout</i>. The minimum timeout is 1
|
|
2688
|
-
* second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is
|
|
2689
|
-
* 30 seconds.</p>
|
|
2690
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Response timeout (custom origins only)</a> in the
|
|
2691
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1719
|
+
* <p>Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the <i>origin response timeout</i>. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Response timeout (custom origins only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2692
1720
|
* @public
|
|
2693
1721
|
*/
|
|
2694
1722
|
OriginReadTimeout?: number | undefined;
|
|
2695
1723
|
/**
|
|
2696
|
-
* <p>Specifies how long, in seconds, CloudFront persists its connection to the origin. The
|
|
2697
|
-
* minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't
|
|
2698
|
-
* specify otherwise) is 5 seconds.</p>
|
|
2699
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout">Keep-alive timeout (custom origins only)</a> in the
|
|
2700
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1724
|
+
* <p>Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout">Keep-alive timeout (custom origins only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2701
1725
|
* @public
|
|
2702
1726
|
*/
|
|
2703
1727
|
OriginKeepaliveTimeout?: number | undefined;
|
|
2704
1728
|
}
|
|
2705
1729
|
/**
|
|
2706
|
-
* <p>CloudFront Origin Shield.</p>
|
|
2707
|
-
* <p>Using Origin Shield can help reduce the load on your origin. For more information, see
|
|
2708
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html">Using Origin Shield</a> in the
|
|
2709
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1730
|
+
* <p>CloudFront Origin Shield.</p> <p>Using Origin Shield can help reduce the load on your origin. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html">Using Origin Shield</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2710
1731
|
* @public
|
|
2711
1732
|
*/
|
|
2712
1733
|
export interface OriginShield {
|
|
2713
1734
|
/**
|
|
2714
|
-
* <p>A flag that specifies whether Origin Shield is enabled.</p>
|
|
2715
|
-
* <p>When it's enabled, CloudFront routes all requests through Origin Shield, which can help
|
|
2716
|
-
* protect your origin. When it's disabled, CloudFront might send requests directly to your
|
|
2717
|
-
* origin from multiple edge locations or regional edge caches.</p>
|
|
1735
|
+
* <p>A flag that specifies whether Origin Shield is enabled.</p> <p>When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.</p>
|
|
2718
1736
|
* @public
|
|
2719
1737
|
*/
|
|
2720
1738
|
Enabled: boolean | undefined;
|
|
2721
1739
|
/**
|
|
2722
|
-
* <p>The Amazon Web Services Region for Origin Shield.</p>
|
|
2723
|
-
* <p>Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a
|
|
2724
|
-
* region, use the region code, not the region name. For example, specify the US East
|
|
2725
|
-
* (Ohio) region as <code>us-east-2</code>.</p>
|
|
2726
|
-
* <p>When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin
|
|
2727
|
-
* Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the
|
|
2728
|
-
* best Region for your origin, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region">Choosing the Amazon Web Services Region for Origin Shield</a> in the
|
|
2729
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1740
|
+
* <p>The Amazon Web Services Region for Origin Shield.</p> <p>Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as <code>us-east-2</code>.</p> <p>When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region">Choosing the Amazon Web Services Region for Origin Shield</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2730
1741
|
* @public
|
|
2731
1742
|
*/
|
|
2732
1743
|
OriginShieldRegion?: string | undefined;
|
|
2733
1744
|
}
|
|
2734
1745
|
/**
|
|
2735
|
-
* <p>A complex type that contains information about the Amazon S3 origin. If the origin is a
|
|
2736
|
-
* custom origin or an S3 bucket that is configured as a website endpoint, use the
|
|
2737
|
-
* <code>CustomOriginConfig</code> element instead.</p>
|
|
1746
|
+
* <p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the <code>CustomOriginConfig</code> element instead.</p>
|
|
2738
1747
|
* @public
|
|
2739
1748
|
*/
|
|
2740
1749
|
export interface S3OriginConfig {
|
|
2741
1750
|
/**
|
|
2742
|
-
* <note>
|
|
2743
|
-
* <p>If you're using origin access control (OAC) instead of origin access identity,
|
|
2744
|
-
* specify an empty <code>OriginAccessIdentity</code> element. For more information,
|
|
2745
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html">Restricting access to an Amazon Web Services</a> in the
|
|
2746
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2747
|
-
* </note>
|
|
2748
|
-
* <p>The CloudFront origin access identity to associate with the origin. Use an origin access
|
|
2749
|
-
* identity to configure the origin so that viewers can <i>only</i> access
|
|
2750
|
-
* objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p>
|
|
2751
|
-
* <p>
|
|
2752
|
-
* <code>origin-access-identity/cloudfront/ID-of-origin-access-identity</code>
|
|
2753
|
-
* </p>
|
|
2754
|
-
* <p>The <code>
|
|
2755
|
-
* <i>ID-of-origin-access-identity</i>
|
|
2756
|
-
* </code> is the value that CloudFront
|
|
2757
|
-
* returned in the <code>ID</code> element when you created the origin access
|
|
2758
|
-
* identity.</p>
|
|
2759
|
-
* <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3
|
|
2760
|
-
* URL, specify an empty <code>OriginAccessIdentity</code> element.</p>
|
|
2761
|
-
* <p>To delete the origin access identity from an existing distribution, update the
|
|
2762
|
-
* distribution configuration and include an empty <code>OriginAccessIdentity</code>
|
|
2763
|
-
* element.</p>
|
|
2764
|
-
* <p>To replace the origin access identity, update the distribution configuration and
|
|
2765
|
-
* specify the new origin access identity.</p>
|
|
2766
|
-
* <p>For more information about the origin access identity, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private
|
|
2767
|
-
* Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1751
|
+
* <note> <p>If you're using origin access control (OAC) instead of origin access identity, specify an empty <code>OriginAccessIdentity</code> element. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html">Restricting access to an Amazon Web Services</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note> <p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p> <code>origin-access-identity/cloudfront/ID-of-origin-access-identity</code> </p> <p>The <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2768
1752
|
* @public
|
|
2769
1753
|
*/
|
|
2770
1754
|
OriginAccessIdentity: string | undefined;
|
|
@@ -2780,110 +1764,48 @@ export interface VpcOriginConfig {
|
|
|
2780
1764
|
*/
|
|
2781
1765
|
VpcOriginId: string | undefined;
|
|
2782
1766
|
/**
|
|
2783
|
-
* <p>Specifies how long, in seconds, CloudFront waits for a response from the origin. This is
|
|
2784
|
-
* also known as the <i>origin response timeout</i>. The minimum timeout is 1
|
|
2785
|
-
* second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is
|
|
2786
|
-
* 30 seconds.</p>
|
|
2787
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Response timeout (custom origins only)</a> in the
|
|
2788
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1767
|
+
* <p>Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the <i>origin response timeout</i>. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Response timeout (custom origins only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2789
1768
|
* @public
|
|
2790
1769
|
*/
|
|
2791
1770
|
OriginReadTimeout?: number | undefined;
|
|
2792
1771
|
/**
|
|
2793
|
-
* <p>Specifies how long, in seconds, CloudFront persists its connection to the origin. The
|
|
2794
|
-
* minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't
|
|
2795
|
-
* specify otherwise) is 5 seconds.</p>
|
|
2796
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout">Keep-alive timeout (custom origins only)</a> in the
|
|
2797
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1772
|
+
* <p>Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout">Keep-alive timeout (custom origins only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2798
1773
|
* @public
|
|
2799
1774
|
*/
|
|
2800
1775
|
OriginKeepaliveTimeout?: number | undefined;
|
|
2801
1776
|
}
|
|
2802
1777
|
/**
|
|
2803
|
-
* <p>An origin.</p>
|
|
2804
|
-
* <p>An origin is the location where content is stored, and from which CloudFront gets content to
|
|
2805
|
-
* serve to viewers. To specify an origin:</p>
|
|
2806
|
-
* <ul>
|
|
2807
|
-
* <li>
|
|
2808
|
-
* <p>Use <code>S3OriginConfig</code> to specify an Amazon S3 bucket that is not
|
|
2809
|
-
* configured with static website hosting.</p>
|
|
2810
|
-
* </li>
|
|
2811
|
-
* <li>
|
|
2812
|
-
* <p>Use <code>VpcOriginConfig</code> to specify a VPC origin.</p>
|
|
2813
|
-
* </li>
|
|
2814
|
-
* <li>
|
|
2815
|
-
* <p>Use <code>CustomOriginConfig</code> to specify all other kinds of origins,
|
|
2816
|
-
* including:</p>
|
|
2817
|
-
* <ul>
|
|
2818
|
-
* <li>
|
|
2819
|
-
* <p>An Amazon S3 bucket that is configured with static website hosting</p>
|
|
2820
|
-
* </li>
|
|
2821
|
-
* <li>
|
|
2822
|
-
* <p>An Elastic Load Balancing load balancer</p>
|
|
2823
|
-
* </li>
|
|
2824
|
-
* <li>
|
|
2825
|
-
* <p>An Elemental MediaPackage endpoint</p>
|
|
2826
|
-
* </li>
|
|
2827
|
-
* <li>
|
|
2828
|
-
* <p>An Elemental MediaStore container</p>
|
|
2829
|
-
* </li>
|
|
2830
|
-
* <li>
|
|
2831
|
-
* <p>Any other HTTP server, running on an Amazon EC2 instance or any other kind
|
|
2832
|
-
* of host</p>
|
|
2833
|
-
* </li>
|
|
2834
|
-
* </ul>
|
|
2835
|
-
* </li>
|
|
2836
|
-
* </ul>
|
|
2837
|
-
* <p>For the current maximum number of origins that you can specify per distribution, see
|
|
2838
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions">General Quotas on Web Distributions</a> in the
|
|
2839
|
-
* <i>Amazon CloudFront Developer Guide</i> (quotas were formerly referred to as
|
|
2840
|
-
* limits).</p>
|
|
1778
|
+
* <p>An origin.</p> <p>An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:</p> <ul> <li> <p>Use <code>S3OriginConfig</code> to specify an Amazon S3 bucket that is not configured with static website hosting.</p> </li> <li> <p>Use <code>VpcOriginConfig</code> to specify a VPC origin.</p> </li> <li> <p>Use <code>CustomOriginConfig</code> to specify all other kinds of origins, including:</p> <ul> <li> <p>An Amazon S3 bucket that is configured with static website hosting</p> </li> <li> <p>An Elastic Load Balancing load balancer</p> </li> <li> <p>An Elemental MediaPackage endpoint</p> </li> <li> <p>An Elemental MediaStore container</p> </li> <li> <p>Any other HTTP server, running on an Amazon EC2 instance or any other kind of host</p> </li> </ul> </li> </ul> <p>For the current maximum number of origins that you can specify per distribution, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions">General Quotas on Web Distributions</a> in the <i>Amazon CloudFront Developer Guide</i> (quotas were formerly referred to as limits).</p>
|
|
2841
1779
|
* @public
|
|
2842
1780
|
*/
|
|
2843
1781
|
export interface Origin {
|
|
2844
1782
|
/**
|
|
2845
|
-
* <p>A unique identifier for the origin. This value must be unique within the
|
|
2846
|
-
* distribution.</p>
|
|
2847
|
-
* <p>Use this value to specify the <code>TargetOriginId</code> in a
|
|
2848
|
-
* <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>.</p>
|
|
1783
|
+
* <p>A unique identifier for the origin. This value must be unique within the distribution.</p> <p>Use this value to specify the <code>TargetOriginId</code> in a <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>.</p>
|
|
2849
1784
|
* @public
|
|
2850
1785
|
*/
|
|
2851
1786
|
Id: string | undefined;
|
|
2852
1787
|
/**
|
|
2853
|
-
* <p>The domain name for the origin.</p>
|
|
2854
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName">Origin Domain Name</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1788
|
+
* <p>The domain name for the origin.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName">Origin Domain Name</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2855
1789
|
* @public
|
|
2856
1790
|
*/
|
|
2857
1791
|
DomainName: string | undefined;
|
|
2858
1792
|
/**
|
|
2859
|
-
* <p>An optional path that CloudFront appends to the origin domain name when CloudFront requests
|
|
2860
|
-
* content from the origin.</p>
|
|
2861
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath">Origin Path</a> in the
|
|
2862
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1793
|
+
* <p>An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath">Origin Path</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2863
1794
|
* @public
|
|
2864
1795
|
*/
|
|
2865
1796
|
OriginPath?: string | undefined;
|
|
2866
1797
|
/**
|
|
2867
|
-
* <p>A list of HTTP header names and values that CloudFront adds to the requests that it sends to
|
|
2868
|
-
* the origin.</p>
|
|
2869
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html">Adding Custom Headers to Origin Requests</a> in the
|
|
2870
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1798
|
+
* <p>A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html">Adding Custom Headers to Origin Requests</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2871
1799
|
* @public
|
|
2872
1800
|
*/
|
|
2873
1801
|
CustomHeaders?: CustomHeaders | undefined;
|
|
2874
1802
|
/**
|
|
2875
|
-
* <p>Use this type to specify an origin that is an Amazon S3 bucket that is not configured with
|
|
2876
|
-
* static website hosting. To specify any other type of origin, including an Amazon S3 bucket
|
|
2877
|
-
* that is configured with static website hosting, use the <code>CustomOriginConfig</code>
|
|
2878
|
-
* type instead.</p>
|
|
1803
|
+
* <p>Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the <code>CustomOriginConfig</code> type instead.</p>
|
|
2879
1804
|
* @public
|
|
2880
1805
|
*/
|
|
2881
1806
|
S3OriginConfig?: S3OriginConfig | undefined;
|
|
2882
1807
|
/**
|
|
2883
|
-
* <p>Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If
|
|
2884
|
-
* the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3
|
|
2885
|
-
* bucket is not configured with static website hosting, use the
|
|
2886
|
-
* <code>S3OriginConfig</code> type instead.</p>
|
|
1808
|
+
* <p>Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the <code>S3OriginConfig</code> type instead.</p>
|
|
2887
1809
|
* @public
|
|
2888
1810
|
*/
|
|
2889
1811
|
CustomOriginConfig?: CustomOriginConfig | undefined;
|
|
@@ -2893,36 +1815,22 @@ export interface Origin {
|
|
|
2893
1815
|
*/
|
|
2894
1816
|
VpcOriginConfig?: VpcOriginConfig | undefined;
|
|
2895
1817
|
/**
|
|
2896
|
-
* <p>The number of times that CloudFront attempts to connect to the origin. The minimum number is
|
|
2897
|
-
* 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.</p>
|
|
2898
|
-
* <p>For a custom origin (including an Amazon S3 bucket that's configured with static website
|
|
2899
|
-
* hosting), this value also specifies the number of times that CloudFront attempts to get a
|
|
2900
|
-
* response from the origin, in the case of an <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Origin Response Timeout</a>.</p>
|
|
2901
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts">Origin Connection Attempts</a> in the
|
|
2902
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1818
|
+
* <p>The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.</p> <p>For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout">Origin Response Timeout</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts">Origin Connection Attempts</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2903
1819
|
* @public
|
|
2904
1820
|
*/
|
|
2905
1821
|
ConnectionAttempts?: number | undefined;
|
|
2906
1822
|
/**
|
|
2907
|
-
* <p>The number of seconds that CloudFront waits when trying to establish a connection to the
|
|
2908
|
-
* origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if
|
|
2909
|
-
* you don't specify otherwise) is 10 seconds.</p>
|
|
2910
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout">Origin Connection Timeout</a> in the
|
|
2911
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1823
|
+
* <p>The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout">Origin Connection Timeout</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2912
1824
|
* @public
|
|
2913
1825
|
*/
|
|
2914
1826
|
ConnectionTimeout?: number | undefined;
|
|
2915
1827
|
/**
|
|
2916
|
-
* <p>CloudFront Origin Shield. Using Origin Shield can help reduce the load on your
|
|
2917
|
-
* origin.</p>
|
|
2918
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html">Using Origin Shield</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1828
|
+
* <p>CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html">Using Origin Shield</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2919
1829
|
* @public
|
|
2920
1830
|
*/
|
|
2921
1831
|
OriginShield?: OriginShield | undefined;
|
|
2922
1832
|
/**
|
|
2923
|
-
* <p>The unique identifier of an origin access control for this origin.</p>
|
|
2924
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html">Restricting access to an Amazon S3 origin</a> in the
|
|
2925
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
1833
|
+
* <p>The unique identifier of an origin access control for this origin.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html">Restricting access to an Amazon S3 origin</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2926
1834
|
* @public
|
|
2927
1835
|
*/
|
|
2928
1836
|
OriginAccessControlId?: string | undefined;
|
|
@@ -2971,67 +1879,33 @@ export declare const GeoRestrictionType: {
|
|
|
2971
1879
|
*/
|
|
2972
1880
|
export type GeoRestrictionType = (typeof GeoRestrictionType)[keyof typeof GeoRestrictionType];
|
|
2973
1881
|
/**
|
|
2974
|
-
* <p>A complex type that controls the countries in which your content is distributed. CloudFront
|
|
2975
|
-
* determines the location of your users using <code>MaxMind</code> GeoIP databases.
|
|
2976
|
-
* </p>
|
|
1882
|
+
* <p>A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using <code>MaxMind</code> GeoIP databases. </p>
|
|
2977
1883
|
* @public
|
|
2978
1884
|
*/
|
|
2979
1885
|
export interface GeoRestriction {
|
|
2980
1886
|
/**
|
|
2981
|
-
* <p>The method that you want to use to restrict distribution of your content by country:</p>
|
|
2982
|
-
* <ul>
|
|
2983
|
-
* <li>
|
|
2984
|
-
* <p>
|
|
2985
|
-
* <code>none</code>: No geo restriction is enabled, meaning access to content is
|
|
2986
|
-
* not restricted by client geo location.</p>
|
|
2987
|
-
* </li>
|
|
2988
|
-
* <li>
|
|
2989
|
-
* <p>
|
|
2990
|
-
* <code>blacklist</code>: The <code>Location</code> elements specify the
|
|
2991
|
-
* countries in which you don't want CloudFront to distribute your content.</p>
|
|
2992
|
-
* </li>
|
|
2993
|
-
* <li>
|
|
2994
|
-
* <p>
|
|
2995
|
-
* <code>whitelist</code>: The <code>Location</code> elements specify the
|
|
2996
|
-
* countries in which you want CloudFront to distribute your content.</p>
|
|
2997
|
-
* </li>
|
|
2998
|
-
* </ul>
|
|
1887
|
+
* <p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>
|
|
2999
1888
|
* @public
|
|
3000
1889
|
*/
|
|
3001
1890
|
RestrictionType: GeoRestrictionType | undefined;
|
|
3002
1891
|
/**
|
|
3003
|
-
* <p>When geo restriction is <code>enabled</code>, this is the number of countries in your
|
|
3004
|
-
* <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled,
|
|
3005
|
-
* <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>
|
|
1892
|
+
* <p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>
|
|
3006
1893
|
* @public
|
|
3007
1894
|
*/
|
|
3008
1895
|
Quantity: number | undefined;
|
|
3009
1896
|
/**
|
|
3010
|
-
* <p>A complex type that contains a <code>Location</code> element for each country in
|
|
3011
|
-
* which you want CloudFront either to distribute your content (<code>whitelist</code>) or not
|
|
3012
|
-
* distribute your content (<code>blacklist</code>).</p>
|
|
3013
|
-
* <p>The <code>Location</code> element is a two-letter, uppercase country code for a
|
|
3014
|
-
* country that you want to include in your <code>blacklist</code> or
|
|
3015
|
-
* <code>whitelist</code>. Include one <code>Location</code> element for each
|
|
3016
|
-
* country.</p>
|
|
3017
|
-
* <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the
|
|
3018
|
-
* current list of countries and the corresponding codes, see <code>ISO
|
|
3019
|
-
* 3166-1-alpha-2</code> code on the <i>International Organization for
|
|
3020
|
-
* Standardization</i> website. You can also refer to the country list on the
|
|
3021
|
-
* CloudFront console, which includes both country names and codes.</p>
|
|
1897
|
+
* <p>A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</p>
|
|
3022
1898
|
* @public
|
|
3023
1899
|
*/
|
|
3024
1900
|
Items?: string[] | undefined;
|
|
3025
1901
|
}
|
|
3026
1902
|
/**
|
|
3027
|
-
* <p>A complex type that identifies ways in which you want to restrict distribution of your
|
|
3028
|
-
* content.</p>
|
|
1903
|
+
* <p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>
|
|
3029
1904
|
* @public
|
|
3030
1905
|
*/
|
|
3031
1906
|
export interface Restrictions {
|
|
3032
1907
|
/**
|
|
3033
|
-
* <p>A complex type that controls the countries in which your content is distributed. CloudFront
|
|
3034
|
-
* determines the location of your users using <code>MaxMind</code> GeoIP databases.</p>
|
|
1908
|
+
* <p>A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using <code>MaxMind</code> GeoIP databases.</p>
|
|
3035
1909
|
* @public
|
|
3036
1910
|
*/
|
|
3037
1911
|
GeoRestriction: GeoRestriction | undefined;
|
|
@@ -3126,215 +2000,44 @@ export declare const SSLSupportMethod: {
|
|
|
3126
2000
|
*/
|
|
3127
2001
|
export type SSLSupportMethod = (typeof SSLSupportMethod)[keyof typeof SSLSupportMethod];
|
|
3128
2002
|
/**
|
|
3129
|
-
* <p>A complex type that determines the distribution's SSL/TLS configuration for
|
|
3130
|
-
* communicating with viewers.</p>
|
|
3131
|
-
* <p>If the distribution doesn't use <code>Aliases</code> (also known as alternate domain
|
|
3132
|
-
* names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as
|
|
3133
|
-
* <code>d111111abcdef8.cloudfront.net</code>—set
|
|
3134
|
-
* <code>CloudFrontDefaultCertificate</code> to <code>true</code> and leave all other
|
|
3135
|
-
* fields empty.</p>
|
|
3136
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), use
|
|
3137
|
-
* the fields in this type to specify the following settings:</p>
|
|
3138
|
-
* <ul>
|
|
3139
|
-
* <li>
|
|
3140
|
-
* <p>Which viewers the distribution accepts HTTPS connections from: only viewers
|
|
3141
|
-
* that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a> (recommended), or all viewers
|
|
3142
|
-
* including those that don't support SNI.</p>
|
|
3143
|
-
* <ul>
|
|
3144
|
-
* <li>
|
|
3145
|
-
* <p>To accept HTTPS connections from only viewers that support SNI, set
|
|
3146
|
-
* <code>SSLSupportMethod</code> to <code>sni-only</code>. This is
|
|
3147
|
-
* recommended. Most browsers and clients support SNI. </p>
|
|
3148
|
-
* </li>
|
|
3149
|
-
* <li>
|
|
3150
|
-
* <p>To accept HTTPS connections from all viewers, including those that
|
|
3151
|
-
* don't support SNI, set <code>SSLSupportMethod</code> to
|
|
3152
|
-
* <code>vip</code>. This is not recommended, and results in additional
|
|
3153
|
-
* monthly charges from CloudFront.</p>
|
|
3154
|
-
* </li>
|
|
3155
|
-
* </ul>
|
|
3156
|
-
* </li>
|
|
3157
|
-
* <li>
|
|
3158
|
-
* <p>The minimum SSL/TLS protocol version that the distribution can use to
|
|
3159
|
-
* communicate with viewers. To specify a minimum version, choose a value for
|
|
3160
|
-
* <code>MinimumProtocolVersion</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> in the
|
|
3161
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3162
|
-
* </li>
|
|
3163
|
-
* <li>
|
|
3164
|
-
* <p>The location of the SSL/TLS certificate, <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager
|
|
3165
|
-
* (ACM)</a> (recommended) or <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>. You specify the location by
|
|
3166
|
-
* setting a value in one of the following fields (not both):</p>
|
|
3167
|
-
* <ul>
|
|
3168
|
-
* <li>
|
|
3169
|
-
* <p>
|
|
3170
|
-
* <code>ACMCertificateArn</code>
|
|
3171
|
-
* </p>
|
|
3172
|
-
* </li>
|
|
3173
|
-
* <li>
|
|
3174
|
-
* <p>
|
|
3175
|
-
* <code>IAMCertificateId</code>
|
|
3176
|
-
* </p>
|
|
3177
|
-
* </li>
|
|
3178
|
-
* </ul>
|
|
3179
|
-
* </li>
|
|
3180
|
-
* </ul>
|
|
3181
|
-
* <p>All distributions support HTTPS connections from viewers. To require viewers to use
|
|
3182
|
-
* HTTPS only, or to redirect them from HTTP to HTTPS, use
|
|
3183
|
-
* <code>ViewerProtocolPolicy</code> in the <code>CacheBehavior</code> or
|
|
3184
|
-
* <code>DefaultCacheBehavior</code>. To specify how CloudFront should use SSL/TLS to
|
|
3185
|
-
* communicate with your custom origin, use <code>CustomOriginConfig</code>.</p>
|
|
3186
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html">Using HTTPS with CloudFront</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html"> Using Alternate Domain Names and HTTPS</a> in the
|
|
3187
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2003
|
+
* <p>A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.</p> <p>If the distribution doesn't use <code>Aliases</code> (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>—set <code>CloudFrontDefaultCertificate</code> to <code>true</code> and leave all other fields empty.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:</p> <ul> <li> <p>Which viewers the distribution accepts HTTPS connections from: only viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a> (recommended), or all viewers including those that don't support SNI.</p> <ul> <li> <p>To accept HTTPS connections from only viewers that support SNI, set <code>SSLSupportMethod</code> to <code>sni-only</code>. This is recommended. Most browsers and clients support SNI. </p> </li> <li> <p>To accept HTTPS connections from all viewers, including those that don't support SNI, set <code>SSLSupportMethod</code> to <code>vip</code>. This is not recommended, and results in additional monthly charges from CloudFront.</p> </li> </ul> </li> <li> <p>The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for <code>MinimumProtocolVersion</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> <li> <p>The location of the SSL/TLS certificate, <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a> (recommended) or <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>. You specify the location by setting a value in one of the following fields (not both):</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> </ul> </li> </ul> <p>All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use <code>ViewerProtocolPolicy</code> in the <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use <code>CustomOriginConfig</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html">Using HTTPS with CloudFront</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html"> Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3188
2004
|
* @public
|
|
3189
2005
|
*/
|
|
3190
2006
|
export interface ViewerCertificate {
|
|
3191
2007
|
/**
|
|
3192
|
-
* <p>If the distribution uses the CloudFront domain name such as
|
|
3193
|
-
* <code>d111111abcdef8.cloudfront.net</code>, set this field to
|
|
3194
|
-
* <code>true</code>.</p>
|
|
3195
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set
|
|
3196
|
-
* this field to <code>false</code> and specify values for the following fields:</p>
|
|
3197
|
-
* <ul>
|
|
3198
|
-
* <li>
|
|
3199
|
-
* <p>
|
|
3200
|
-
* <code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a
|
|
3201
|
-
* value for one, not both)</p>
|
|
3202
|
-
* </li>
|
|
3203
|
-
* <li>
|
|
3204
|
-
* <p>
|
|
3205
|
-
* <code>MinimumProtocolVersion</code>
|
|
3206
|
-
* </p>
|
|
3207
|
-
* </li>
|
|
3208
|
-
* <li>
|
|
3209
|
-
* <p>
|
|
3210
|
-
* <code>SSLSupportMethod</code>
|
|
3211
|
-
* </p>
|
|
3212
|
-
* </li>
|
|
3213
|
-
* </ul>
|
|
2008
|
+
* <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, set this field to <code>true</code>.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set this field to <code>false</code> and specify values for the following fields:</p> <ul> <li> <p> <code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a value for one, not both)</p> </li> <li> <p> <code>MinimumProtocolVersion</code> </p> </li> <li> <p> <code>SSLSupportMethod</code> </p> </li> </ul>
|
|
3214
2009
|
* @public
|
|
3215
2010
|
*/
|
|
3216
2011
|
CloudFrontDefaultCertificate?: boolean | undefined;
|
|
3217
2012
|
/**
|
|
3218
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and
|
|
3219
|
-
* the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>, provide the ID of the IAM certificate.</p>
|
|
3220
|
-
* <p>If you specify an IAM certificate ID, you must also specify values for
|
|
3221
|
-
* <code>MinimumProtocolVersion</code> and <code>SSLSupportMethod</code>. </p>
|
|
2013
|
+
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>, provide the ID of the IAM certificate.</p> <p>If you specify an IAM certificate ID, you must also specify values for <code>MinimumProtocolVersion</code> and <code>SSLSupportMethod</code>. </p>
|
|
3222
2014
|
* @public
|
|
3223
2015
|
*/
|
|
3224
2016
|
IAMCertificateId?: string | undefined;
|
|
3225
2017
|
/**
|
|
3226
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and
|
|
3227
|
-
* the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a>, provide the Amazon Resource Name
|
|
3228
|
-
* (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East
|
|
3229
|
-
* (N. Virginia) Region (<code>us-east-1</code>).</p>
|
|
3230
|
-
* <p>If you specify an ACM certificate ARN, you must also specify values for
|
|
3231
|
-
* <code>MinimumProtocolVersion</code> and <code>SSLSupportMethod</code>.</p>
|
|
2018
|
+
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a>, provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (<code>us-east-1</code>).</p> <p>If you specify an ACM certificate ARN, you must also specify values for <code>MinimumProtocolVersion</code> and <code>SSLSupportMethod</code>.</p>
|
|
3232
2019
|
* @public
|
|
3233
2020
|
*/
|
|
3234
2021
|
ACMCertificateArn?: string | undefined;
|
|
3235
2022
|
/**
|
|
3236
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs),
|
|
3237
|
-
* specify which viewers the distribution accepts HTTPS connections from.</p>
|
|
3238
|
-
* <ul>
|
|
3239
|
-
* <li>
|
|
3240
|
-
* <p>
|
|
3241
|
-
* <code>sni-only</code> – The distribution accepts HTTPS connections from only
|
|
3242
|
-
* viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name
|
|
3243
|
-
* indication (SNI)</a>. This is recommended. Most browsers and clients
|
|
3244
|
-
* support SNI.</p>
|
|
3245
|
-
* </li>
|
|
3246
|
-
* <li>
|
|
3247
|
-
* <p>
|
|
3248
|
-
* <code>vip</code> – The distribution accepts HTTPS connections from all viewers
|
|
3249
|
-
* including those that don't support SNI. This is not recommended, and results in
|
|
3250
|
-
* additional monthly charges from CloudFront.</p>
|
|
3251
|
-
* </li>
|
|
3252
|
-
* <li>
|
|
3253
|
-
* <p>
|
|
3254
|
-
* <code>static-ip</code> - Do not specify this value unless your distribution
|
|
3255
|
-
* has been enabled for this feature by the CloudFront team. If you have a use case
|
|
3256
|
-
* that requires static IP addresses for a distribution, contact CloudFront through
|
|
3257
|
-
* the <a href="https://console.aws.amazon.com/support/home">Amazon Web Services Support Center</a>.</p>
|
|
3258
|
-
* </li>
|
|
3259
|
-
* </ul>
|
|
3260
|
-
* <p>If the distribution uses the CloudFront domain name such as
|
|
3261
|
-
* <code>d111111abcdef8.cloudfront.net</code>, don't set a value for this field.</p>
|
|
2023
|
+
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</p> <ul> <li> <p> <code>sni-only</code> – The distribution accepts HTTPS connections from only viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a>. This is recommended. Most browsers and clients support SNI.</p> </li> <li> <p> <code>vip</code> – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</p> </li> <li> <p> <code>static-ip</code> - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the <a href="https://console.aws.amazon.com/support/home">Amazon Web ServicesSupport Center</a>.</p> </li> </ul> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don't set a value for this field.</p>
|
|
3262
2024
|
* @public
|
|
3263
2025
|
*/
|
|
3264
2026
|
SSLSupportMethod?: SSLSupportMethod | undefined;
|
|
3265
2027
|
/**
|
|
3266
|
-
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs),
|
|
3267
|
-
* specify the security policy that you want CloudFront to use for HTTPS connections with
|
|
3268
|
-
* viewers. The security policy determines two settings:</p>
|
|
3269
|
-
* <ul>
|
|
3270
|
-
* <li>
|
|
3271
|
-
* <p>The minimum SSL/TLS protocol that CloudFront can use to communicate with
|
|
3272
|
-
* viewers.</p>
|
|
3273
|
-
* </li>
|
|
3274
|
-
* <li>
|
|
3275
|
-
* <p>The ciphers that CloudFront can use to encrypt the content that it returns to
|
|
3276
|
-
* viewers.</p>
|
|
3277
|
-
* </li>
|
|
3278
|
-
* </ul>
|
|
3279
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers">Supported Protocols and Ciphers Between Viewers and
|
|
3280
|
-
* CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3281
|
-
* <note>
|
|
3282
|
-
* <p>On the CloudFront console, this setting is called <b>Security
|
|
3283
|
-
* Policy</b>.</p>
|
|
3284
|
-
* </note>
|
|
3285
|
-
* <p>When you're using SNI only (you set <code>SSLSupportMethod</code> to
|
|
3286
|
-
* <code>sni-only</code>), you must specify <code>TLSv1</code> or higher.</p>
|
|
3287
|
-
* <p>If the distribution uses the CloudFront domain name such as
|
|
3288
|
-
* <code>d111111abcdef8.cloudfront.net</code> (you set
|
|
3289
|
-
* <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically
|
|
3290
|
-
* sets the security policy to <code>TLSv1</code> regardless of the value that you set
|
|
3291
|
-
* here.</p>
|
|
2028
|
+
* <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</p> </li> <li> <p>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>On the CloudFront console, this setting is called <b>Security Policy</b>.</p> </note> <p>When you're using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher.</p> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</p>
|
|
3292
2029
|
* @public
|
|
3293
2030
|
*/
|
|
3294
2031
|
MinimumProtocolVersion?: MinimumProtocolVersion | undefined;
|
|
3295
2032
|
/**
|
|
3296
|
-
* <p>This field is deprecated. Use one of the following fields instead:</p>
|
|
3297
|
-
* <ul>
|
|
3298
|
-
* <li>
|
|
3299
|
-
* <p>
|
|
3300
|
-
* <code>ACMCertificateArn</code>
|
|
3301
|
-
* </p>
|
|
3302
|
-
* </li>
|
|
3303
|
-
* <li>
|
|
3304
|
-
* <p>
|
|
3305
|
-
* <code>IAMCertificateId</code>
|
|
3306
|
-
* </p>
|
|
3307
|
-
* </li>
|
|
3308
|
-
* <li>
|
|
3309
|
-
* <p>
|
|
3310
|
-
* <code>CloudFrontDefaultCertificate</code>
|
|
3311
|
-
* </p>
|
|
3312
|
-
* </li>
|
|
3313
|
-
* </ul>
|
|
2033
|
+
* <p>This field is deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> <li> <p> <code>CloudFrontDefaultCertificate</code> </p> </li> </ul>
|
|
3314
2034
|
*
|
|
3315
2035
|
* @deprecated
|
|
3316
2036
|
* @public
|
|
3317
2037
|
*/
|
|
3318
2038
|
Certificate?: string | undefined;
|
|
3319
2039
|
/**
|
|
3320
|
-
* <p>This field is deprecated. Use one of the following fields instead:</p>
|
|
3321
|
-
* <ul>
|
|
3322
|
-
* <li>
|
|
3323
|
-
* <p>
|
|
3324
|
-
* <code>ACMCertificateArn</code>
|
|
3325
|
-
* </p>
|
|
3326
|
-
* </li>
|
|
3327
|
-
* <li>
|
|
3328
|
-
* <p>
|
|
3329
|
-
* <code>IAMCertificateId</code>
|
|
3330
|
-
* </p>
|
|
3331
|
-
* </li>
|
|
3332
|
-
* <li>
|
|
3333
|
-
* <p>
|
|
3334
|
-
* <code>CloudFrontDefaultCertificate</code>
|
|
3335
|
-
* </p>
|
|
3336
|
-
* </li>
|
|
3337
|
-
* </ul>
|
|
2040
|
+
* <p>This field is deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> <li> <p> <code>CloudFrontDefaultCertificate</code> </p> </li> </ul>
|
|
3338
2041
|
*
|
|
3339
2042
|
* @deprecated
|
|
3340
2043
|
* @public
|
|
@@ -3347,43 +2050,17 @@ export interface ViewerCertificate {
|
|
|
3347
2050
|
*/
|
|
3348
2051
|
export interface DistributionConfig {
|
|
3349
2052
|
/**
|
|
3350
|
-
* <p>A unique value (for example, a date-time stamp) that ensures that the request can't be
|
|
3351
|
-
* replayed.</p>
|
|
3352
|
-
* <p>If the value of <code>CallerReference</code> is new (regardless of the content of the
|
|
3353
|
-
* <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p>
|
|
3354
|
-
* <p>If <code>CallerReference</code> is a value that you already sent in a previous request
|
|
3355
|
-
* to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code>
|
|
3356
|
-
* error.</p>
|
|
2053
|
+
* <p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>
|
|
3357
2054
|
* @public
|
|
3358
2055
|
*/
|
|
3359
2056
|
CallerReference: string | undefined;
|
|
3360
2057
|
/**
|
|
3361
|
-
* <p>A complex type that contains information about CNAMEs (alternate domain names), if
|
|
3362
|
-
* any, for this distribution.</p>
|
|
2058
|
+
* <p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>
|
|
3363
2059
|
* @public
|
|
3364
2060
|
*/
|
|
3365
2061
|
Aliases?: Aliases | undefined;
|
|
3366
2062
|
/**
|
|
3367
|
-
* <p>When a viewer requests the root URL for your distribution, the default root object is the
|
|
3368
|
-
* object that you want CloudFront to request from your origin. For example, if your root URL is
|
|
3369
|
-
* <code>https://www.example.com</code>, you can specify CloudFront to return the
|
|
3370
|
-
* <code>index.html</code> file as the default root object. You can specify a default
|
|
3371
|
-
* root object so that viewers see a specific file or object, instead of another object in
|
|
3372
|
-
* your distribution (for example,
|
|
3373
|
-
* <code>https://www.example.com/product-description.html</code>). A default root
|
|
3374
|
-
* object avoids exposing the contents of your distribution.</p>
|
|
3375
|
-
* <p>You can specify the object name or a path to the object name (for example,
|
|
3376
|
-
* <code>index.html</code> or <code>exampleFolderName/index.html</code>). Your string
|
|
3377
|
-
* can't begin with a forward slash (<code>/</code>). Only specify the object name or the
|
|
3378
|
-
* path to the object.</p>
|
|
3379
|
-
* <p>If you don't want to specify a default root object when you create a distribution,
|
|
3380
|
-
* include an empty <code>DefaultRootObject</code> element.</p>
|
|
3381
|
-
* <p>To delete the default root object from an existing distribution, update the
|
|
3382
|
-
* distribution configuration and include an empty <code>DefaultRootObject</code>
|
|
3383
|
-
* element.</p>
|
|
3384
|
-
* <p>To replace the default root object, update the distribution configuration and specify
|
|
3385
|
-
* the new object.</p>
|
|
3386
|
-
* <p>For more information about the default root object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html">Specify a default root object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2063
|
+
* <p>When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is <code>https://www.example.com</code>, you can specify CloudFront to return the <code>index.html</code> file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, <code>https://www.example.com/product-description.html</code>). A default root object avoids exposing the contents of your distribution.</p> <p>You can specify the object name or a path to the object name (for example, <code>index.html</code> or <code>exampleFolderName/index.html</code>). Your string can't begin with a forward slash (<code>/</code>). Only specify the object name or the path to the object.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html">Specify a default root object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3387
2064
|
* @public
|
|
3388
2065
|
*/
|
|
3389
2066
|
DefaultRootObject?: string | undefined;
|
|
@@ -3393,16 +2070,12 @@ export interface DistributionConfig {
|
|
|
3393
2070
|
*/
|
|
3394
2071
|
Origins: Origins | undefined;
|
|
3395
2072
|
/**
|
|
3396
|
-
* <p>A complex type that contains information about origin groups for this
|
|
3397
|
-
* distribution.</p>
|
|
2073
|
+
* <p>A complex type that contains information about origin groups for this distribution.</p>
|
|
3398
2074
|
* @public
|
|
3399
2075
|
*/
|
|
3400
2076
|
OriginGroups?: OriginGroups | undefined;
|
|
3401
2077
|
/**
|
|
3402
|
-
* <p>A complex type that describes the default cache behavior if you don't specify a
|
|
3403
|
-
* <code>CacheBehavior</code> element or if files don't match any of the values of
|
|
3404
|
-
* <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create
|
|
3405
|
-
* exactly one default cache behavior.</p>
|
|
2078
|
+
* <p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>
|
|
3406
2079
|
* @public
|
|
3407
2080
|
*/
|
|
3408
2081
|
DefaultCacheBehavior: DefaultCacheBehavior | undefined;
|
|
@@ -3412,48 +2085,22 @@ export interface DistributionConfig {
|
|
|
3412
2085
|
*/
|
|
3413
2086
|
CacheBehaviors?: CacheBehaviors | undefined;
|
|
3414
2087
|
/**
|
|
3415
|
-
* <p>A complex type that controls the following:</p>
|
|
3416
|
-
* <ul>
|
|
3417
|
-
* <li>
|
|
3418
|
-
* <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom
|
|
3419
|
-
* error messages before returning the response to the viewer.</p>
|
|
3420
|
-
* </li>
|
|
3421
|
-
* <li>
|
|
3422
|
-
* <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p>
|
|
3423
|
-
* </li>
|
|
3424
|
-
* </ul>
|
|
3425
|
-
* <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing
|
|
3426
|
-
* Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2088
|
+
* <p>A complex type that controls the following:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3427
2089
|
* @public
|
|
3428
2090
|
*/
|
|
3429
2091
|
CustomErrorResponses?: CustomErrorResponses | undefined;
|
|
3430
2092
|
/**
|
|
3431
|
-
* <p>A comment to describe the distribution. The comment cannot be longer than
|
|
3432
|
-
* 128 characters.</p>
|
|
2093
|
+
* <p>A comment to describe the distribution. The comment cannot be longer than 128 characters.</p>
|
|
3433
2094
|
* @public
|
|
3434
2095
|
*/
|
|
3435
2096
|
Comment: string | undefined;
|
|
3436
2097
|
/**
|
|
3437
|
-
* <p>A complex type that controls whether access logs are written for the
|
|
3438
|
-
* distribution.</p>
|
|
3439
|
-
* <p>For more information about logging, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html">Access Logs</a> in
|
|
3440
|
-
* the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2098
|
+
* <p>A complex type that controls whether access logs are written for the distribution.</p> <p>For more information about logging, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html">Access Logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3441
2099
|
* @public
|
|
3442
2100
|
*/
|
|
3443
2101
|
Logging?: LoggingConfig | undefined;
|
|
3444
2102
|
/**
|
|
3445
|
-
* <p>The price class that corresponds with the maximum price that you want to pay for CloudFront
|
|
3446
|
-
* service. If you specify <code>PriceClass_All</code>, CloudFront responds to requests for your
|
|
3447
|
-
* objects from all CloudFront edge locations.</p>
|
|
3448
|
-
* <p>If you specify a price class other than <code>PriceClass_All</code>, CloudFront serves your
|
|
3449
|
-
* objects from the CloudFront edge location that has the lowest latency among the edge locations
|
|
3450
|
-
* in your price class. Viewers who are in or near regions that are excluded from your
|
|
3451
|
-
* specified price class may encounter slower performance.</p>
|
|
3452
|
-
* <p>For more information about price classes, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html">Choosing the Price
|
|
3453
|
-
* Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.
|
|
3454
|
-
* For information about CloudFront pricing, including how price classes (such as Price Class
|
|
3455
|
-
* 100) map to CloudFront regions, see <a href="http://aws.amazon.com/cloudfront/pricing/">Amazon CloudFront
|
|
3456
|
-
* Pricing</a>.</p>
|
|
2103
|
+
* <p>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</p> <p>If you specify a price class other than <code>PriceClass_All</code>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</p> <p>For more information about price classes, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see <a href="http://aws.amazon.com/cloudfront/pricing/">Amazon CloudFront Pricing</a>.</p>
|
|
3457
2104
|
* @public
|
|
3458
2105
|
*/
|
|
3459
2106
|
PriceClass?: PriceClass | undefined;
|
|
@@ -3463,92 +2110,37 @@ export interface DistributionConfig {
|
|
|
3463
2110
|
*/
|
|
3464
2111
|
Enabled: boolean | undefined;
|
|
3465
2112
|
/**
|
|
3466
|
-
* <p>A complex type that determines the distribution's SSL/TLS configuration for
|
|
3467
|
-
* communicating with viewers.</p>
|
|
2113
|
+
* <p>A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.</p>
|
|
3468
2114
|
* @public
|
|
3469
2115
|
*/
|
|
3470
2116
|
ViewerCertificate?: ViewerCertificate | undefined;
|
|
3471
2117
|
/**
|
|
3472
|
-
* <p>A complex type that identifies ways in which you want to restrict distribution of your
|
|
3473
|
-
* content.</p>
|
|
2118
|
+
* <p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>
|
|
3474
2119
|
* @public
|
|
3475
2120
|
*/
|
|
3476
2121
|
Restrictions?: Restrictions | undefined;
|
|
3477
2122
|
/**
|
|
3478
|
-
* <p>A unique identifier that specifies the WAF web ACL, if any, to associate with this
|
|
3479
|
-
* distribution. To specify a web ACL created using the latest version of WAF, use the
|
|
3480
|
-
* ACL ARN, for example
|
|
3481
|
-
* <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.
|
|
3482
|
-
* To specify a web ACL created using WAF Classic, use the ACL ID, for example
|
|
3483
|
-
* <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
3484
|
-
* <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests
|
|
3485
|
-
* that are forwarded to CloudFront, and lets you control access to your content. Based on
|
|
3486
|
-
* conditions that you specify, such as the IP addresses that requests originate from or
|
|
3487
|
-
* the values of query strings, CloudFront responds to requests either with the requested content
|
|
3488
|
-
* or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a
|
|
3489
|
-
* custom error page when a request is blocked. For more information about WAF, see the
|
|
3490
|
-
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</p>
|
|
2123
|
+
* <p>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 <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>. To specify a web ACL created using WAF Classic, use the ACL ID, for example <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p> <p>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 <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</p>
|
|
3491
2124
|
* @public
|
|
3492
2125
|
*/
|
|
3493
2126
|
WebACLId?: string | undefined;
|
|
3494
2127
|
/**
|
|
3495
|
-
* <p>(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with
|
|
3496
|
-
* CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that
|
|
3497
|
-
* don't support HTTP/2 automatically use an earlier HTTP version.</p>
|
|
3498
|
-
* <p>For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must
|
|
3499
|
-
* support Server Name Indication (SNI).</p>
|
|
3500
|
-
* <p>For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name
|
|
3501
|
-
* Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to
|
|
3502
|
-
* switch networks without losing connection. For more information about connection
|
|
3503
|
-
* migration, see <a href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration">Connection Migration</a> at RFC 9000. For more information about supported
|
|
3504
|
-
* TLSv1.3 ciphers, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html">Supported protocols and ciphers between viewers and CloudFront</a>.</p>
|
|
2128
|
+
* <p>(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</p> <p>For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).</p> <p>For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see <a href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration">Connection Migration</a> at RFC 9000. For more information about supported TLSv1.3 ciphers, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html">Supported protocols and ciphers between viewers and CloudFront</a>.</p>
|
|
3505
2129
|
* @public
|
|
3506
2130
|
*/
|
|
3507
2131
|
HttpVersion?: HttpVersion | undefined;
|
|
3508
2132
|
/**
|
|
3509
|
-
* <p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your
|
|
3510
|
-
* distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront
|
|
3511
|
-
* responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with
|
|
3512
|
-
* no IP addresses. This allows viewers to submit a second request, for an IPv4 address for
|
|
3513
|
-
* your distribution.</p>
|
|
3514
|
-
* <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to
|
|
3515
|
-
* access your content. However, if you're using signed URLs or signed cookies to restrict
|
|
3516
|
-
* access to your content, and if you're using a custom policy that includes the
|
|
3517
|
-
* <code>IpAddress</code> parameter to restrict the IP addresses that can access your
|
|
3518
|
-
* content, don't enable IPv6. If you want to restrict access to some content by IP address
|
|
3519
|
-
* and not restrict access to other content (or restrict access but not by IP address), you
|
|
3520
|
-
* can create two distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html">Creating a Signed URL Using a Custom Policy</a> in the
|
|
3521
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3522
|
-
* <p>If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront
|
|
3523
|
-
* distribution, you need to create a second alias resource record set when both of the
|
|
3524
|
-
* following are true:</p>
|
|
3525
|
-
* <ul>
|
|
3526
|
-
* <li>
|
|
3527
|
-
* <p>You enable IPv6 for the distribution</p>
|
|
3528
|
-
* </li>
|
|
3529
|
-
* <li>
|
|
3530
|
-
* <p>You're using alternate domain names in the URLs for your objects</p>
|
|
3531
|
-
* </li>
|
|
3532
|
-
* </ul>
|
|
3533
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html">Routing
|
|
3534
|
-
* Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the
|
|
3535
|
-
* <i>Route 53 Amazon Web Services Integration Developer Guide</i>.</p>
|
|
3536
|
-
* <p>If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS
|
|
3537
|
-
* service, you don't need to make any changes. A CNAME record will route traffic to your
|
|
3538
|
-
* distribution regardless of the IP address format of the viewer request.</p>
|
|
2133
|
+
* <p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.</p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Route 53 Amazon Web Services Integration Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>
|
|
3539
2134
|
* @public
|
|
3540
2135
|
*/
|
|
3541
2136
|
IsIPV6Enabled?: boolean | undefined;
|
|
3542
2137
|
/**
|
|
3543
|
-
* <p>The identifier of a continuous deployment policy. For more information, see
|
|
3544
|
-
* <code>CreateContinuousDeploymentPolicy</code>.</p>
|
|
2138
|
+
* <p>The identifier of a continuous deployment policy. For more information, see <code>CreateContinuousDeploymentPolicy</code>.</p>
|
|
3545
2139
|
* @public
|
|
3546
2140
|
*/
|
|
3547
2141
|
ContinuousDeploymentPolicyId?: string | undefined;
|
|
3548
2142
|
/**
|
|
3549
|
-
* <p>A Boolean that indicates whether this is a staging distribution. When this value is
|
|
3550
|
-
* <code>true</code>, this is a staging distribution. When this value is
|
|
3551
|
-
* <code>false</code>, this is not a staging distribution.</p>
|
|
2143
|
+
* <p>A Boolean that indicates whether this is a staging distribution. When this value is <code>true</code>, this is a staging distribution. When this value is <code>false</code>, this is not a staging distribution.</p>
|
|
3552
2144
|
* @public
|
|
3553
2145
|
*/
|
|
3554
2146
|
Staging?: boolean | undefined;
|
|
@@ -3569,8 +2161,7 @@ export interface DistributionConfig {
|
|
|
3569
2161
|
ConnectionMode?: ConnectionMode | undefined;
|
|
3570
2162
|
}
|
|
3571
2163
|
/**
|
|
3572
|
-
* <p>A distribution tells CloudFront where you want content to be delivered from, and the details
|
|
3573
|
-
* about how to track and manage content delivery.</p>
|
|
2164
|
+
* <p>A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.</p>
|
|
3574
2165
|
* @public
|
|
3575
2166
|
*/
|
|
3576
2167
|
export interface Distribution {
|
|
@@ -3585,8 +2176,7 @@ export interface Distribution {
|
|
|
3585
2176
|
*/
|
|
3586
2177
|
ARN: string | undefined;
|
|
3587
2178
|
/**
|
|
3588
|
-
* <p>The distribution's status. When the status is <code>Deployed</code>, the
|
|
3589
|
-
* distribution's information is fully propagated to all CloudFront edge locations.</p>
|
|
2179
|
+
* <p>The distribution's status. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations.</p>
|
|
3590
2180
|
* @public
|
|
3591
2181
|
*/
|
|
3592
2182
|
Status: string | undefined;
|
|
@@ -3601,25 +2191,17 @@ export interface Distribution {
|
|
|
3601
2191
|
*/
|
|
3602
2192
|
InProgressInvalidationBatches: number | undefined;
|
|
3603
2193
|
/**
|
|
3604
|
-
* <p>The distribution's CloudFront domain name. For example:
|
|
3605
|
-
* <code>d111111abcdef8.cloudfront.net</code>.</p>
|
|
2194
|
+
* <p>The distribution's CloudFront domain name. For example: <code>d111111abcdef8.cloudfront.net</code>.</p>
|
|
3606
2195
|
* @public
|
|
3607
2196
|
*/
|
|
3608
2197
|
DomainName: string | undefined;
|
|
3609
2198
|
/**
|
|
3610
|
-
* <important>
|
|
3611
|
-
* <p>We recommend using <code>TrustedKeyGroups</code> instead of
|
|
3612
|
-
* <code>TrustedSigners</code>.</p>
|
|
3613
|
-
* </important>
|
|
3614
|
-
* <p>This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each
|
|
3615
|
-
* account that CloudFront can use to verify the signatures of signed URLs or signed
|
|
3616
|
-
* cookies.</p>
|
|
2199
|
+
* <important> <p>We recommend using <code>TrustedKeyGroups</code> instead of <code>TrustedSigners</code>.</p> </important> <p>This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.</p>
|
|
3617
2200
|
* @public
|
|
3618
2201
|
*/
|
|
3619
2202
|
ActiveTrustedSigners?: ActiveTrustedSigners | undefined;
|
|
3620
2203
|
/**
|
|
3621
|
-
* <p>This field contains a list of key groups and the public keys in each key group that
|
|
3622
|
-
* CloudFront can use to verify the signatures of signed URLs or signed cookies.</p>
|
|
2204
|
+
* <p>This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.</p>
|
|
3623
2205
|
* @public
|
|
3624
2206
|
*/
|
|
3625
2207
|
ActiveTrustedKeyGroups?: ActiveTrustedKeyGroups | undefined;
|
|
@@ -3629,12 +2211,7 @@ export interface Distribution {
|
|
|
3629
2211
|
*/
|
|
3630
2212
|
DistributionConfig: DistributionConfig | undefined;
|
|
3631
2213
|
/**
|
|
3632
|
-
* <p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)
|
|
3633
|
-
* recordal if they want to serve content publicly on an alternate domain name, also known
|
|
3634
|
-
* as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal
|
|
3635
|
-
* status for CNAMEs associated with distributions.</p>
|
|
3636
|
-
* <p>For more information about ICP recordals, see <a href="https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services
|
|
3637
|
-
* services in China</i>.</p>
|
|
2214
|
+
* <p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.</p> <p>For more information about ICP recordals, see <a href="https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>
|
|
3638
2215
|
* @public
|
|
3639
2216
|
*/
|
|
3640
2217
|
AliasICPRecordals?: AliasICPRecordal[] | undefined;
|
|
@@ -3644,8 +2221,7 @@ export interface Distribution {
|
|
|
3644
2221
|
*/
|
|
3645
2222
|
export interface CopyDistributionResult {
|
|
3646
2223
|
/**
|
|
3647
|
-
* <p>A distribution tells CloudFront where you want content to be delivered from, and the details
|
|
3648
|
-
* about how to track and manage content delivery.</p>
|
|
2224
|
+
* <p>A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.</p>
|
|
3649
2225
|
* @public
|
|
3650
2226
|
*/
|
|
3651
2227
|
Distribution?: Distribution | undefined;
|
|
@@ -3661,8 +2237,7 @@ export interface CopyDistributionResult {
|
|
|
3661
2237
|
ETag?: string | undefined;
|
|
3662
2238
|
}
|
|
3663
2239
|
/**
|
|
3664
|
-
* <p>The caller reference you attempted to create the distribution with is associated with
|
|
3665
|
-
* another distribution.</p>
|
|
2240
|
+
* <p>The caller reference you attempted to create the distribution with is associated with another distribution.</p>
|
|
3666
2241
|
* @public
|
|
3667
2242
|
*/
|
|
3668
2243
|
export declare class DistributionAlreadyExists extends __BaseException {
|
|
@@ -3675,8 +2250,7 @@ export declare class DistributionAlreadyExists extends __BaseException {
|
|
|
3675
2250
|
constructor(opts: __ExceptionOptionType<DistributionAlreadyExists, __BaseException>);
|
|
3676
2251
|
}
|
|
3677
2252
|
/**
|
|
3678
|
-
* <p>The specified configuration for field-level encryption can't be associated with the
|
|
3679
|
-
* specified cache behavior.</p>
|
|
2253
|
+
* <p>The specified configuration for field-level encryption can't be associated with the specified cache behavior.</p>
|
|
3680
2254
|
* @public
|
|
3681
2255
|
*/
|
|
3682
2256
|
export declare class IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior extends __BaseException {
|
|
@@ -3689,8 +2263,7 @@ export declare class IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavi
|
|
|
3689
2263
|
constructor(opts: __ExceptionOptionType<IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior, __BaseException>);
|
|
3690
2264
|
}
|
|
3691
2265
|
/**
|
|
3692
|
-
* <p>The value of <code>Quantity</code> and the size of <code>Items</code> don't
|
|
3693
|
-
* match.</p>
|
|
2266
|
+
* <p>The value of <code>Quantity</code> and the size of <code>Items</code> don't match.</p>
|
|
3694
2267
|
* @public
|
|
3695
2268
|
*/
|
|
3696
2269
|
export declare class InconsistentQuantities extends __BaseException {
|
|
@@ -3729,9 +2302,7 @@ export declare class InvalidErrorCode extends __BaseException {
|
|
|
3729
2302
|
constructor(opts: __ExceptionOptionType<InvalidErrorCode, __BaseException>);
|
|
3730
2303
|
}
|
|
3731
2304
|
/**
|
|
3732
|
-
* <p>Your request contains forward cookies option which doesn't match with the expectation
|
|
3733
|
-
* for the <code>whitelisted</code> list of cookie names. Either list of cookie names has
|
|
3734
|
-
* been specified when not allowed or list of cookie names is missing when expected.</p>
|
|
2305
|
+
* <p>Your request contains forward cookies option which doesn't match with the expectation for the <code>whitelisted</code> list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.</p>
|
|
3735
2306
|
* @public
|
|
3736
2307
|
*/
|
|
3737
2308
|
export declare class InvalidForwardCookies extends __BaseException {
|
|
@@ -3887,8 +2458,7 @@ export declare class InvalidOriginReadTimeout extends __BaseException {
|
|
|
3887
2458
|
constructor(opts: __ExceptionOptionType<InvalidOriginReadTimeout, __BaseException>);
|
|
3888
2459
|
}
|
|
3889
2460
|
/**
|
|
3890
|
-
* <p>You cannot specify SSLv3 as the minimum protocol version if you only want to support
|
|
3891
|
-
* only clients that support Server Name Indication (SNI).</p>
|
|
2461
|
+
* <p>You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).</p>
|
|
3892
2462
|
* @public
|
|
3893
2463
|
*/
|
|
3894
2464
|
export declare class InvalidProtocolSettings extends __BaseException {
|
|
@@ -3914,8 +2484,7 @@ export declare class InvalidQueryStringParameters extends __BaseException {
|
|
|
3914
2484
|
constructor(opts: __ExceptionOptionType<InvalidQueryStringParameters, __BaseException>);
|
|
3915
2485
|
}
|
|
3916
2486
|
/**
|
|
3917
|
-
* <p>The relative path is too big, is not URL-encoded, or does not begin with a slash
|
|
3918
|
-
* (/).</p>
|
|
2487
|
+
* <p>The relative path is too big, is not URL-encoded, or does not begin with a slash (/).</p>
|
|
3919
2488
|
* @public
|
|
3920
2489
|
*/
|
|
3921
2490
|
export declare class InvalidRelativePath extends __BaseException {
|
|
@@ -3928,9 +2497,7 @@ export declare class InvalidRelativePath extends __BaseException {
|
|
|
3928
2497
|
constructor(opts: __ExceptionOptionType<InvalidRelativePath, __BaseException>);
|
|
3929
2498
|
}
|
|
3930
2499
|
/**
|
|
3931
|
-
* <p>This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol
|
|
3932
|
-
* in your request, or omit the <code>RequiredProtocols</code> element from your
|
|
3933
|
-
* distribution configuration.</p>
|
|
2500
|
+
* <p>This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the <code>RequiredProtocols</code> element from your distribution configuration.</p>
|
|
3934
2501
|
* @public
|
|
3935
2502
|
*/
|
|
3936
2503
|
export declare class InvalidRequiredProtocol extends __BaseException {
|
|
@@ -3982,11 +2549,7 @@ export declare class InvalidViewerCertificate extends __BaseException {
|
|
|
3982
2549
|
constructor(opts: __ExceptionOptionType<InvalidViewerCertificate, __BaseException>);
|
|
3983
2550
|
}
|
|
3984
2551
|
/**
|
|
3985
|
-
* <p>A web ACL ID specified is not valid. To specify a web ACL created using the latest
|
|
3986
|
-
* version of WAF, use the ACL ARN, for example
|
|
3987
|
-
* <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>.
|
|
3988
|
-
* To specify a web ACL created using WAF Classic, use the ACL ID, for example
|
|
3989
|
-
* <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</p>
|
|
2552
|
+
* <p>A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</p>
|
|
3990
2553
|
* @public
|
|
3991
2554
|
*/
|
|
3992
2555
|
export declare class InvalidWebACLId extends __BaseException {
|
|
@@ -3999,8 +2562,7 @@ export declare class InvalidWebACLId extends __BaseException {
|
|
|
3999
2562
|
constructor(opts: __ExceptionOptionType<InvalidWebACLId, __BaseException>);
|
|
4000
2563
|
}
|
|
4001
2564
|
/**
|
|
4002
|
-
* <p>This operation requires a body. Ensure that the body is present and the
|
|
4003
|
-
* <code>Content-Type</code> header is set.</p>
|
|
2565
|
+
* <p>This operation requires a body. Ensure that the body is present and the <code>Content-Type</code> header is set.</p>
|
|
4004
2566
|
* @public
|
|
4005
2567
|
*/
|
|
4006
2568
|
export declare class MissingBody extends __BaseException {
|
|
@@ -4130,8 +2692,7 @@ export declare class TooManyCertificates extends __BaseException {
|
|
|
4130
2692
|
constructor(opts: __ExceptionOptionType<TooManyCertificates, __BaseException>);
|
|
4131
2693
|
}
|
|
4132
2694
|
/**
|
|
4133
|
-
* <p>Your request contains more cookie names in the whitelist than are allowed per cache
|
|
4134
|
-
* behavior.</p>
|
|
2695
|
+
* <p>Your request contains more cookie names in the whitelist than are allowed per cache behavior.</p>
|
|
4135
2696
|
* @public
|
|
4136
2697
|
*/
|
|
4137
2698
|
export declare class TooManyCookieNamesInWhiteList extends __BaseException {
|
|
@@ -4144,8 +2705,7 @@ export declare class TooManyCookieNamesInWhiteList extends __BaseException {
|
|
|
4144
2705
|
constructor(opts: __ExceptionOptionType<TooManyCookieNamesInWhiteList, __BaseException>);
|
|
4145
2706
|
}
|
|
4146
2707
|
/**
|
|
4147
|
-
* <p>Processing your request would cause you to exceed the maximum number of distributions
|
|
4148
|
-
* allowed.</p>
|
|
2708
|
+
* <p>Processing your request would cause you to exceed the maximum number of distributions allowed.</p>
|
|
4149
2709
|
* @public
|
|
4150
2710
|
*/
|
|
4151
2711
|
export declare class TooManyDistributions extends __BaseException {
|
|
@@ -4158,9 +2718,7 @@ export declare class TooManyDistributions extends __BaseException {
|
|
|
4158
2718
|
constructor(opts: __ExceptionOptionType<TooManyDistributions, __BaseException>);
|
|
4159
2719
|
}
|
|
4160
2720
|
/**
|
|
4161
|
-
* <p>The maximum number of distributions have been associated with the specified cache
|
|
4162
|
-
* policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4163
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2721
|
+
* <p>The maximum number of distributions have been associated with the specified cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4164
2722
|
* @public
|
|
4165
2723
|
*/
|
|
4166
2724
|
export declare class TooManyDistributionsAssociatedToCachePolicy extends __BaseException {
|
|
@@ -4173,8 +2731,7 @@ export declare class TooManyDistributionsAssociatedToCachePolicy extends __BaseE
|
|
|
4173
2731
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToCachePolicy, __BaseException>);
|
|
4174
2732
|
}
|
|
4175
2733
|
/**
|
|
4176
|
-
* <p>The maximum number of distributions have been associated with the specified
|
|
4177
|
-
* configuration for field-level encryption.</p>
|
|
2734
|
+
* <p>The maximum number of distributions have been associated with the specified configuration for field-level encryption.</p>
|
|
4178
2735
|
* @public
|
|
4179
2736
|
*/
|
|
4180
2737
|
export declare class TooManyDistributionsAssociatedToFieldLevelEncryptionConfig extends __BaseException {
|
|
@@ -4187,9 +2744,7 @@ export declare class TooManyDistributionsAssociatedToFieldLevelEncryptionConfig
|
|
|
4187
2744
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToFieldLevelEncryptionConfig, __BaseException>);
|
|
4188
2745
|
}
|
|
4189
2746
|
/**
|
|
4190
|
-
* <p>The number of distributions that reference this key group is more than the maximum
|
|
4191
|
-
* allowed. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4192
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2747
|
+
* <p>The number of distributions that reference this key group is more than the maximum allowed. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4193
2748
|
* @public
|
|
4194
2749
|
*/
|
|
4195
2750
|
export declare class TooManyDistributionsAssociatedToKeyGroup extends __BaseException {
|
|
@@ -4202,10 +2757,7 @@ export declare class TooManyDistributionsAssociatedToKeyGroup extends __BaseExce
|
|
|
4202
2757
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToKeyGroup, __BaseException>);
|
|
4203
2758
|
}
|
|
4204
2759
|
/**
|
|
4205
|
-
* <p>The maximum number of distributions have been associated with the specified origin
|
|
4206
|
-
* access control.</p>
|
|
4207
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4208
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2760
|
+
* <p>The maximum number of distributions have been associated with the specified origin access control.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4209
2761
|
* @public
|
|
4210
2762
|
*/
|
|
4211
2763
|
export declare class TooManyDistributionsAssociatedToOriginAccessControl extends __BaseException {
|
|
@@ -4218,9 +2770,7 @@ export declare class TooManyDistributionsAssociatedToOriginAccessControl extends
|
|
|
4218
2770
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToOriginAccessControl, __BaseException>);
|
|
4219
2771
|
}
|
|
4220
2772
|
/**
|
|
4221
|
-
* <p>The maximum number of distributions have been associated with the specified origin
|
|
4222
|
-
* request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4223
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2773
|
+
* <p>The maximum number of distributions have been associated with the specified origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4224
2774
|
* @public
|
|
4225
2775
|
*/
|
|
4226
2776
|
export declare class TooManyDistributionsAssociatedToOriginRequestPolicy extends __BaseException {
|
|
@@ -4233,10 +2783,7 @@ export declare class TooManyDistributionsAssociatedToOriginRequestPolicy extends
|
|
|
4233
2783
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToOriginRequestPolicy, __BaseException>);
|
|
4234
2784
|
}
|
|
4235
2785
|
/**
|
|
4236
|
-
* <p>The maximum number of distributions have been associated with the specified response
|
|
4237
|
-
* headers policy.</p>
|
|
4238
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4239
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2786
|
+
* <p>The maximum number of distributions have been associated with the specified response headers policy.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4240
2787
|
* @public
|
|
4241
2788
|
*/
|
|
4242
2789
|
export declare class TooManyDistributionsAssociatedToResponseHeadersPolicy extends __BaseException {
|
|
@@ -4249,9 +2796,7 @@ export declare class TooManyDistributionsAssociatedToResponseHeadersPolicy exten
|
|
|
4249
2796
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsAssociatedToResponseHeadersPolicy, __BaseException>);
|
|
4250
2797
|
}
|
|
4251
2798
|
/**
|
|
4252
|
-
* <p>You have reached the maximum number of distributions that are associated with a CloudFront
|
|
4253
|
-
* function. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4254
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2799
|
+
* <p>You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4255
2800
|
* @public
|
|
4256
2801
|
*/
|
|
4257
2802
|
export declare class TooManyDistributionsWithFunctionAssociations extends __BaseException {
|
|
@@ -4264,8 +2809,7 @@ export declare class TooManyDistributionsWithFunctionAssociations extends __Base
|
|
|
4264
2809
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsWithFunctionAssociations, __BaseException>);
|
|
4265
2810
|
}
|
|
4266
2811
|
/**
|
|
4267
|
-
* <p>Processing your request would cause the maximum number of distributions with
|
|
4268
|
-
* Lambda@Edge function associations per owner to be exceeded.</p>
|
|
2812
|
+
* <p>Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.</p>
|
|
4269
2813
|
* @public
|
|
4270
2814
|
*/
|
|
4271
2815
|
export declare class TooManyDistributionsWithLambdaAssociations extends __BaseException {
|
|
@@ -4278,8 +2822,7 @@ export declare class TooManyDistributionsWithLambdaAssociations extends __BaseEx
|
|
|
4278
2822
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsWithLambdaAssociations, __BaseException>);
|
|
4279
2823
|
}
|
|
4280
2824
|
/**
|
|
4281
|
-
* <p>The maximum number of distributions have been associated with the specified
|
|
4282
|
-
* Lambda@Edge function.</p>
|
|
2825
|
+
* <p>The maximum number of distributions have been associated with the specified Lambda@Edge function.</p>
|
|
4283
2826
|
* @public
|
|
4284
2827
|
*/
|
|
4285
2828
|
export declare class TooManyDistributionsWithSingleFunctionARN extends __BaseException {
|
|
@@ -4292,9 +2835,7 @@ export declare class TooManyDistributionsWithSingleFunctionARN extends __BaseExc
|
|
|
4292
2835
|
constructor(opts: __ExceptionOptionType<TooManyDistributionsWithSingleFunctionARN, __BaseException>);
|
|
4293
2836
|
}
|
|
4294
2837
|
/**
|
|
4295
|
-
* <p>You have reached the maximum number of CloudFront function associations for this
|
|
4296
|
-
* distribution. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4297
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2838
|
+
* <p>You have reached the maximum number of CloudFront function associations for this distribution. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4298
2839
|
* @public
|
|
4299
2840
|
*/
|
|
4300
2841
|
export declare class TooManyFunctionAssociations extends __BaseException {
|
|
@@ -4320,9 +2861,7 @@ export declare class TooManyHeadersInForwardedValues extends __BaseException {
|
|
|
4320
2861
|
constructor(opts: __ExceptionOptionType<TooManyHeadersInForwardedValues, __BaseException>);
|
|
4321
2862
|
}
|
|
4322
2863
|
/**
|
|
4323
|
-
* <p>The number of key groups referenced by this distribution is more than the maximum
|
|
4324
|
-
* allowed. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4325
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
2864
|
+
* <p>The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4326
2865
|
* @public
|
|
4327
2866
|
*/
|
|
4328
2867
|
export declare class TooManyKeyGroupsAssociatedToDistribution extends __BaseException {
|
|
@@ -4335,8 +2874,7 @@ export declare class TooManyKeyGroupsAssociatedToDistribution extends __BaseExce
|
|
|
4335
2874
|
constructor(opts: __ExceptionOptionType<TooManyKeyGroupsAssociatedToDistribution, __BaseException>);
|
|
4336
2875
|
}
|
|
4337
2876
|
/**
|
|
4338
|
-
* <p>Your request contains more Lambda@Edge function associations than are allowed per
|
|
4339
|
-
* distribution.</p>
|
|
2877
|
+
* <p>Your request contains more Lambda@Edge function associations than are allowed per distribution.</p>
|
|
4340
2878
|
* @public
|
|
4341
2879
|
*/
|
|
4342
2880
|
export declare class TooManyLambdaFunctionAssociations extends __BaseException {
|
|
@@ -4362,8 +2900,7 @@ export declare class TooManyOriginCustomHeaders extends __BaseException {
|
|
|
4362
2900
|
constructor(opts: __ExceptionOptionType<TooManyOriginCustomHeaders, __BaseException>);
|
|
4363
2901
|
}
|
|
4364
2902
|
/**
|
|
4365
|
-
* <p>Processing your request would cause you to exceed the maximum number of origin groups
|
|
4366
|
-
* allowed.</p>
|
|
2903
|
+
* <p>Processing your request would cause you to exceed the maximum number of origin groups allowed.</p>
|
|
4367
2904
|
* @public
|
|
4368
2905
|
*/
|
|
4369
2906
|
export declare class TooManyOriginGroupsPerDistribution extends __BaseException {
|
|
@@ -4446,18 +2983,12 @@ export declare class TrustedSignerDoesNotExist extends __BaseException {
|
|
|
4446
2983
|
*/
|
|
4447
2984
|
export interface Tag {
|
|
4448
2985
|
/**
|
|
4449
|
-
* <p>A string that contains <code>Tag</code> key.</p>
|
|
4450
|
-
* <p>The string length should be between 1 and 128 characters. Valid characters include
|
|
4451
|
-
* <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special
|
|
4452
|
-
* characters <code>_ - . : / = + @</code>.</p>
|
|
2986
|
+
* <p>A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>
|
|
4453
2987
|
* @public
|
|
4454
2988
|
*/
|
|
4455
2989
|
Key: string | undefined;
|
|
4456
2990
|
/**
|
|
4457
|
-
* <p>A string that contains an optional <code>Tag</code> value.</p>
|
|
4458
|
-
* <p>The string length should be between 0 and 256 characters. Valid characters include
|
|
4459
|
-
* <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special
|
|
4460
|
-
* characters <code>_ - . : / = + @</code>.</p>
|
|
2991
|
+
* <p>A string that contains an optional <code>Tag</code> value.</p> <p>The string length should be between 0 and 256 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>
|
|
4461
2992
|
* @public
|
|
4462
2993
|
*/
|
|
4463
2994
|
Value?: string | undefined;
|
|
@@ -4509,8 +3040,7 @@ export interface CreateAnycastIpListResult {
|
|
|
4509
3040
|
ETag?: string | undefined;
|
|
4510
3041
|
}
|
|
4511
3042
|
/**
|
|
4512
|
-
* <p>The entity already exists. You must provide a unique
|
|
4513
|
-
* entity.</p>
|
|
3043
|
+
* <p>The entity already exists. You must provide a unique entity.</p>
|
|
4514
3044
|
* @public
|
|
4515
3045
|
*/
|
|
4516
3046
|
export declare class EntityAlreadyExists extends __BaseException {
|
|
@@ -4592,9 +3122,7 @@ export interface CreateCachePolicyResult {
|
|
|
4592
3122
|
ETag?: string | undefined;
|
|
4593
3123
|
}
|
|
4594
3124
|
/**
|
|
4595
|
-
* <p>You have reached the maximum number of cache policies for this Amazon Web Services account. For more
|
|
4596
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4597
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3125
|
+
* <p>You have reached the maximum number of cache policies for this Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4598
3126
|
* @public
|
|
4599
3127
|
*/
|
|
4600
3128
|
export declare class TooManyCachePolicies extends __BaseException {
|
|
@@ -4607,9 +3135,7 @@ export declare class TooManyCachePolicies extends __BaseException {
|
|
|
4607
3135
|
constructor(opts: __ExceptionOptionType<TooManyCachePolicies, __BaseException>);
|
|
4608
3136
|
}
|
|
4609
3137
|
/**
|
|
4610
|
-
* <p>The number of cookies in the cache policy exceeds the maximum. For more information,
|
|
4611
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4612
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3138
|
+
* <p>The number of cookies in the cache policy exceeds the maximum. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4613
3139
|
* @public
|
|
4614
3140
|
*/
|
|
4615
3141
|
export declare class TooManyCookiesInCachePolicy extends __BaseException {
|
|
@@ -4622,9 +3148,7 @@ export declare class TooManyCookiesInCachePolicy extends __BaseException {
|
|
|
4622
3148
|
constructor(opts: __ExceptionOptionType<TooManyCookiesInCachePolicy, __BaseException>);
|
|
4623
3149
|
}
|
|
4624
3150
|
/**
|
|
4625
|
-
* <p>The number of headers in the cache policy exceeds the maximum. For more information,
|
|
4626
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4627
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3151
|
+
* <p>The number of headers in the cache policy exceeds the maximum. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4628
3152
|
* @public
|
|
4629
3153
|
*/
|
|
4630
3154
|
export declare class TooManyHeadersInCachePolicy extends __BaseException {
|
|
@@ -4637,9 +3161,7 @@ export declare class TooManyHeadersInCachePolicy extends __BaseException {
|
|
|
4637
3161
|
constructor(opts: __ExceptionOptionType<TooManyHeadersInCachePolicy, __BaseException>);
|
|
4638
3162
|
}
|
|
4639
3163
|
/**
|
|
4640
|
-
* <p>The number of query strings in the cache policy exceeds the maximum. For more
|
|
4641
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
4642
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3164
|
+
* <p>The number of query strings in the cache policy exceeds the maximum. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4643
3165
|
* @public
|
|
4644
3166
|
*/
|
|
4645
3167
|
export declare class TooManyQueryStringsInCachePolicy extends __BaseException {
|
|
@@ -4652,11 +3174,7 @@ export declare class TooManyQueryStringsInCachePolicy extends __BaseException {
|
|
|
4652
3174
|
constructor(opts: __ExceptionOptionType<TooManyQueryStringsInCachePolicy, __BaseException>);
|
|
4653
3175
|
}
|
|
4654
3176
|
/**
|
|
4655
|
-
* <p>If the <code>CallerReference</code> is a value you already sent in a previous request
|
|
4656
|
-
* to create an identity but the content of the
|
|
4657
|
-
* <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original
|
|
4658
|
-
* request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error.
|
|
4659
|
-
* </p>
|
|
3177
|
+
* <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>
|
|
4660
3178
|
* @public
|
|
4661
3179
|
*/
|
|
4662
3180
|
export declare class CloudFrontOriginAccessIdentityAlreadyExists extends __BaseException {
|
|
@@ -4669,42 +3187,23 @@ export declare class CloudFrontOriginAccessIdentityAlreadyExists extends __BaseE
|
|
|
4669
3187
|
constructor(opts: __ExceptionOptionType<CloudFrontOriginAccessIdentityAlreadyExists, __BaseException>);
|
|
4670
3188
|
}
|
|
4671
3189
|
/**
|
|
4672
|
-
* <p>Origin access identity configuration. Send a <code>GET</code> request to the
|
|
4673
|
-
* <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code>
|
|
4674
|
-
* resource.</p>
|
|
3190
|
+
* <p>Origin access identity configuration. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code> resource.</p>
|
|
4675
3191
|
* @public
|
|
4676
3192
|
*/
|
|
4677
3193
|
export interface CloudFrontOriginAccessIdentityConfig {
|
|
4678
3194
|
/**
|
|
4679
|
-
* <p>A unique value (for example, a date-time stamp) that ensures that the request can't be
|
|
4680
|
-
* replayed.</p>
|
|
4681
|
-
* <p>If the value of <code>CallerReference</code> is new (regardless of the content of the
|
|
4682
|
-
* <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access
|
|
4683
|
-
* identity is created.</p>
|
|
4684
|
-
* <p>If the <code>CallerReference</code> is a value already sent in a previous identity
|
|
4685
|
-
* request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is
|
|
4686
|
-
* identical to the original request (ignoring white space), the response includes the same
|
|
4687
|
-
* information returned to the original request.</p>
|
|
4688
|
-
* <p>If the <code>CallerReference</code> is a value you already sent in a previous request
|
|
4689
|
-
* to create an identity, but the content of the
|
|
4690
|
-
* <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original
|
|
4691
|
-
* request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error.
|
|
4692
|
-
* </p>
|
|
3195
|
+
* <p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request.</p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>
|
|
4693
3196
|
* @public
|
|
4694
3197
|
*/
|
|
4695
3198
|
CallerReference: string | undefined;
|
|
4696
3199
|
/**
|
|
4697
|
-
* <p>A comment to describe the origin access identity. The comment cannot be longer than
|
|
4698
|
-
* 128 characters.</p>
|
|
3200
|
+
* <p>A comment to describe the origin access identity. The comment cannot be longer than 128 characters.</p>
|
|
4699
3201
|
* @public
|
|
4700
3202
|
*/
|
|
4701
3203
|
Comment: string | undefined;
|
|
4702
3204
|
}
|
|
4703
3205
|
/**
|
|
4704
|
-
* <p>The request to create a new origin access identity (OAI). An origin access identity is
|
|
4705
|
-
* a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all
|
|
4706
|
-
* or just some of your Amazon S3 content. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html"> Restricting Access to Amazon S3 Content by Using an Origin Access Identity</a> in
|
|
4707
|
-
* the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3206
|
+
* <p>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 <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html"> Restricting Access to Amazon S3 Content by Using an Origin Access Identity</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4708
3207
|
* @public
|
|
4709
3208
|
*/
|
|
4710
3209
|
export interface CreateCloudFrontOriginAccessIdentityRequest {
|
|
@@ -4720,14 +3219,12 @@ export interface CreateCloudFrontOriginAccessIdentityRequest {
|
|
|
4720
3219
|
*/
|
|
4721
3220
|
export interface CloudFrontOriginAccessIdentity {
|
|
4722
3221
|
/**
|
|
4723
|
-
* <p>The ID for the origin access identity, for example, <code>E74FTE3AJFJ256A</code>.
|
|
4724
|
-
* </p>
|
|
3222
|
+
* <p>The ID for the origin access identity, for example, <code>E74FTE3AJFJ256A</code>. </p>
|
|
4725
3223
|
* @public
|
|
4726
3224
|
*/
|
|
4727
3225
|
Id: string | undefined;
|
|
4728
3226
|
/**
|
|
4729
|
-
* <p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin
|
|
4730
|
-
* access identity read permission to an object in Amazon S3.</p>
|
|
3227
|
+
* <p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.</p>
|
|
4731
3228
|
* @public
|
|
4732
3229
|
*/
|
|
4733
3230
|
S3CanonicalUserId: string | undefined;
|
|
@@ -4759,8 +3256,7 @@ export interface CreateCloudFrontOriginAccessIdentityResult {
|
|
|
4759
3256
|
ETag?: string | undefined;
|
|
4760
3257
|
}
|
|
4761
3258
|
/**
|
|
4762
|
-
* <p>Processing your request would cause you to exceed the maximum number of origin access
|
|
4763
|
-
* identities allowed.</p>
|
|
3259
|
+
* <p>Processing your request would cause you to exceed the maximum number of origin access identities allowed.</p>
|
|
4764
3260
|
* @public
|
|
4765
3261
|
*/
|
|
4766
3262
|
export declare class TooManyCloudFrontOriginAccessIdentities extends __BaseException {
|
|
@@ -4782,8 +3278,7 @@ export interface CreateConnectionGroupRequest {
|
|
|
4782
3278
|
*/
|
|
4783
3279
|
Name: string | undefined;
|
|
4784
3280
|
/**
|
|
4785
|
-
* <p>Enable IPv6 for the connection group. The default is <code>true</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesEnableIPv6">Enable IPv6</a> in the
|
|
4786
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
3281
|
+
* <p>Enable IPv6 for the connection group. The default is <code>true</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesEnableIPv6">Enable IPv6</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4787
3282
|
* @public
|
|
4788
3283
|
*/
|
|
4789
3284
|
Ipv6Enabled?: boolean | undefined;
|
|
@@ -4914,16 +3409,12 @@ export interface StagingDistributionDnsNames {
|
|
|
4914
3409
|
Items?: string[] | undefined;
|
|
4915
3410
|
}
|
|
4916
3411
|
/**
|
|
4917
|
-
* <p>This configuration determines which HTTP requests are sent to the staging
|
|
4918
|
-
* distribution. If the HTTP request contains a header and value that matches what you
|
|
4919
|
-
* specify here, the request is sent to the staging distribution. Otherwise the request is
|
|
4920
|
-
* sent to the primary distribution.</p>
|
|
3412
|
+
* <p>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.</p>
|
|
4921
3413
|
* @public
|
|
4922
3414
|
*/
|
|
4923
3415
|
export interface ContinuousDeploymentSingleHeaderConfig {
|
|
4924
3416
|
/**
|
|
4925
|
-
* <p>The request header name that you want CloudFront to send to your staging
|
|
4926
|
-
* distribution. The header must contain the prefix <code>aws-cf-cd-</code>.</p>
|
|
3417
|
+
* <p>The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix <code>aws-cf-cd-</code>.</p>
|
|
4927
3418
|
* @public
|
|
4928
3419
|
*/
|
|
4929
3420
|
Header: string | undefined;
|
|
@@ -4934,24 +3425,17 @@ export interface ContinuousDeploymentSingleHeaderConfig {
|
|
|
4934
3425
|
Value: string | undefined;
|
|
4935
3426
|
}
|
|
4936
3427
|
/**
|
|
4937
|
-
* <p>Session stickiness provides the ability to define multiple requests from a single
|
|
4938
|
-
* viewer as a single session. This prevents the potentially inconsistent experience of
|
|
4939
|
-
* sending some of a given user's requests to your staging distribution, while others are
|
|
4940
|
-
* sent to your primary distribution. Define the session duration using TTL values.</p>
|
|
3428
|
+
* <p>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.</p>
|
|
4941
3429
|
* @public
|
|
4942
3430
|
*/
|
|
4943
3431
|
export interface SessionStickinessConfig {
|
|
4944
3432
|
/**
|
|
4945
|
-
* <p>The amount of time after which you want sessions to cease if no requests are
|
|
4946
|
-
* received. Allowed values are 300–3600 seconds (5–60 minutes).</p>
|
|
4947
|
-
* <p>The value must be less than or equal to <code>MaximumTTL</code>.</p>
|
|
3433
|
+
* <p>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).</p> <p>The value must be less than or equal to <code>MaximumTTL</code>.</p>
|
|
4948
3434
|
* @public
|
|
4949
3435
|
*/
|
|
4950
3436
|
IdleTTL: number | undefined;
|
|
4951
3437
|
/**
|
|
4952
|
-
* <p>The maximum amount of time to consider requests from the viewer as being part of the
|
|
4953
|
-
* same session. Allowed values are 300–3600 seconds (5–60 minutes).</p>
|
|
4954
|
-
* <p>The value must be greater than or equal to <code>IdleTTL</code>.</p>
|
|
3438
|
+
* <p>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).</p> <p>The value must be greater than or equal to <code>IdleTTL</code>.</p>
|
|
4955
3439
|
* @public
|
|
4956
3440
|
*/
|
|
4957
3441
|
MaximumTTL: number | undefined;
|
|
@@ -4962,16 +3446,12 @@ export interface SessionStickinessConfig {
|
|
|
4962
3446
|
*/
|
|
4963
3447
|
export interface ContinuousDeploymentSingleWeightConfig {
|
|
4964
3448
|
/**
|
|
4965
|
-
* <p>The percentage of traffic to send to a staging distribution, expressed as a decimal
|
|
4966
|
-
* number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.</p>
|
|
3449
|
+
* <p>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.</p>
|
|
4967
3450
|
* @public
|
|
4968
3451
|
*/
|
|
4969
3452
|
Weight: number | undefined;
|
|
4970
3453
|
/**
|
|
4971
|
-
* <p>Session stickiness provides the ability to define multiple requests from a single
|
|
4972
|
-
* viewer as a single session. This prevents the potentially inconsistent experience of
|
|
4973
|
-
* sending some of a given user's requests to your staging distribution, while others are
|
|
4974
|
-
* sent to your primary distribution. Define the session duration using TTL values.</p>
|
|
3454
|
+
* <p>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.</p>
|
|
4975
3455
|
* @public
|
|
4976
3456
|
*/
|
|
4977
3457
|
SessionStickinessConfig?: SessionStickinessConfig | undefined;
|
|
@@ -5015,22 +3495,17 @@ export interface TrafficConfig {
|
|
|
5015
3495
|
*/
|
|
5016
3496
|
export interface ContinuousDeploymentPolicyConfig {
|
|
5017
3497
|
/**
|
|
5018
|
-
* <p>The CloudFront domain name of the staging distribution. For example:
|
|
5019
|
-
* <code>d111111abcdef8.cloudfront.net</code>.</p>
|
|
3498
|
+
* <p>The CloudFront domain name of the staging distribution. For example: <code>d111111abcdef8.cloudfront.net</code>.</p>
|
|
5020
3499
|
* @public
|
|
5021
3500
|
*/
|
|
5022
3501
|
StagingDistributionDnsNames: StagingDistributionDnsNames | undefined;
|
|
5023
3502
|
/**
|
|
5024
|
-
* <p>A Boolean that indicates whether this continuous deployment policy is enabled (in
|
|
5025
|
-
* effect). When this value is <code>true</code>, this policy is enabled and in effect.
|
|
5026
|
-
* When this value is <code>false</code>, this policy is not enabled and has no
|
|
5027
|
-
* effect.</p>
|
|
3503
|
+
* <p>A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is <code>true</code>, this policy is enabled and in effect. When this value is <code>false</code>, this policy is not enabled and has no effect.</p>
|
|
5028
3504
|
* @public
|
|
5029
3505
|
*/
|
|
5030
3506
|
Enabled: boolean | undefined;
|
|
5031
3507
|
/**
|
|
5032
|
-
* <p>Contains the parameters for routing production traffic from your primary to staging
|
|
5033
|
-
* distributions.</p>
|
|
3508
|
+
* <p>Contains the parameters for routing production traffic from your primary to staging distributions.</p>
|
|
5034
3509
|
* @public
|
|
5035
3510
|
*/
|
|
5036
3511
|
TrafficConfig?: TrafficConfig | undefined;
|
|
@@ -5081,8 +3556,7 @@ export interface CreateContinuousDeploymentPolicyResult {
|
|
|
5081
3556
|
*/
|
|
5082
3557
|
Location?: string | undefined;
|
|
5083
3558
|
/**
|
|
5084
|
-
* <p>The version identifier for the current version of the continuous deployment
|
|
5085
|
-
* policy.</p>
|
|
3559
|
+
* <p>The version identifier for the current version of the continuous deployment policy.</p>
|
|
5086
3560
|
* @public
|
|
5087
3561
|
*/
|
|
5088
3562
|
ETag?: string | undefined;
|
|
@@ -5101,8 +3575,7 @@ export declare class StagingDistributionInUse extends __BaseException {
|
|
|
5101
3575
|
constructor(opts: __ExceptionOptionType<StagingDistributionInUse, __BaseException>);
|
|
5102
3576
|
}
|
|
5103
3577
|
/**
|
|
5104
|
-
* <p>You have reached the maximum number of continuous deployment policies for this
|
|
5105
|
-
* Amazon Web Services account.</p>
|
|
3578
|
+
* <p>You have reached the maximum number of continuous deployment policies for this Amazon Web Services account.</p>
|
|
5106
3579
|
* @public
|
|
5107
3580
|
*/
|
|
5108
3581
|
export declare class TooManyContinuousDeploymentPolicies extends __BaseException {
|
|
@@ -5115,8 +3588,7 @@ export declare class TooManyContinuousDeploymentPolicies extends __BaseException
|
|
|
5115
3588
|
constructor(opts: __ExceptionOptionType<TooManyContinuousDeploymentPolicies, __BaseException>);
|
|
5116
3589
|
}
|
|
5117
3590
|
/**
|
|
5118
|
-
* <p>You cannot delete a continuous deployment policy that is associated with a primary
|
|
5119
|
-
* distribution.</p>
|
|
3591
|
+
* <p>You cannot delete a continuous deployment policy that is associated with a primary distribution.</p>
|
|
5120
3592
|
* @public
|
|
5121
3593
|
*/
|
|
5122
3594
|
export declare class ContinuousDeploymentPolicyInUse extends __BaseException {
|
|
@@ -5161,8 +3633,7 @@ export interface CreateDistributionResult {
|
|
|
5161
3633
|
ETag?: string | undefined;
|
|
5162
3634
|
}
|
|
5163
3635
|
/**
|
|
5164
|
-
* <p>An origin cannot contain both an origin access control (OAC) and an origin access
|
|
5165
|
-
* identity (OAI).</p>
|
|
3636
|
+
* <p>An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).</p>
|
|
5166
3637
|
* @public
|
|
5167
3638
|
*/
|
|
5168
3639
|
export declare class IllegalOriginAccessConfiguration extends __BaseException {
|
|
@@ -5175,8 +3646,7 @@ export declare class IllegalOriginAccessConfiguration extends __BaseException {
|
|
|
5175
3646
|
constructor(opts: __ExceptionOptionType<IllegalOriginAccessConfiguration, __BaseException>);
|
|
5176
3647
|
}
|
|
5177
3648
|
/**
|
|
5178
|
-
* <p>An origin access control is associated with an origin whose domain name is not
|
|
5179
|
-
* supported.</p>
|
|
3649
|
+
* <p>An origin access control is associated with an origin whose domain name is not supported.</p>
|
|
5180
3650
|
* @public
|
|
5181
3651
|
*/
|
|
5182
3652
|
export declare class InvalidDomainNameForOriginAccessControl extends __BaseException {
|
|
@@ -5207,25 +3677,7 @@ export declare class NoSuchContinuousDeploymentPolicy extends __BaseException {
|
|
|
5207
3677
|
*/
|
|
5208
3678
|
export interface GeoRestrictionCustomization {
|
|
5209
3679
|
/**
|
|
5210
|
-
* <p>The method that you want to use to restrict distribution of your content by
|
|
5211
|
-
* country:</p>
|
|
5212
|
-
* <ul>
|
|
5213
|
-
* <li>
|
|
5214
|
-
* <p>
|
|
5215
|
-
* <code>none</code>: No geographic restriction is enabled, meaning access to content is
|
|
5216
|
-
* not restricted by client geo location.</p>
|
|
5217
|
-
* </li>
|
|
5218
|
-
* <li>
|
|
5219
|
-
* <p>
|
|
5220
|
-
* <code>blacklist</code>: The <code>Location</code> elements specify the
|
|
5221
|
-
* countries in which you don't want CloudFront to distribute your content.</p>
|
|
5222
|
-
* </li>
|
|
5223
|
-
* <li>
|
|
5224
|
-
* <p>
|
|
5225
|
-
* <code>whitelist</code>: The <code>Location</code> elements specify the
|
|
5226
|
-
* countries in which you want CloudFront to distribute your content.</p>
|
|
5227
|
-
* </li>
|
|
5228
|
-
* </ul>
|
|
3680
|
+
* <p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>
|
|
5229
3681
|
* @public
|
|
5230
3682
|
*/
|
|
5231
3683
|
RestrictionType: GeoRestrictionType | undefined;
|
|
@@ -5313,15 +3765,7 @@ export type ValidationTokenHost = (typeof ValidationTokenHost)[keyof typeof Vali
|
|
|
5313
3765
|
*/
|
|
5314
3766
|
export interface ManagedCertificateRequest {
|
|
5315
3767
|
/**
|
|
5316
|
-
* <p>Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.</p>
|
|
5317
|
-
* <ul>
|
|
5318
|
-
* <li>
|
|
5319
|
-
* <p>For <code>cloudfront</code>, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.</p>
|
|
5320
|
-
* </li>
|
|
5321
|
-
* <li>
|
|
5322
|
-
* <p>For <code>self-hosted</code>, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.</p>
|
|
5323
|
-
* </li>
|
|
5324
|
-
* </ul>
|
|
3768
|
+
* <p>Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.</p> <ul> <li> <p>For <code>cloudfront</code>, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.</p> </li> <li> <p>For <code>self-hosted</code>, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.</p> </li> </ul>
|
|
5325
3769
|
* @public
|
|
5326
3770
|
*/
|
|
5327
3771
|
ValidationTokenHost: ValidationTokenHost | undefined;
|
|
@@ -5331,10 +3775,7 @@ export interface ManagedCertificateRequest {
|
|
|
5331
3775
|
*/
|
|
5332
3776
|
PrimaryDomainName?: string | undefined;
|
|
5333
3777
|
/**
|
|
5334
|
-
* <p>You can opt out of certificate transparency logging by specifying the <code>disabled</code>
|
|
5335
|
-
* option. Opt in by specifying <code>enabled</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency">Certificate
|
|
5336
|
-
* Transparency Logging </a> in the <i>Certificate Manager User
|
|
5337
|
-
* Guide</i>.</p>
|
|
3778
|
+
* <p>You can opt out of certificate transparency logging by specifying the <code>disabled</code> option. Opt in by specifying <code>enabled</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency">Certificate Transparency Logging </a> in the <i>Certificate Manager User Guide</i>.</p>
|
|
5338
3779
|
* @public
|
|
5339
3780
|
*/
|
|
5340
3781
|
CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference | undefined;
|
|
@@ -5533,8 +3974,7 @@ export declare class InvalidAssociation extends __BaseException {
|
|
|
5533
3974
|
constructor(opts: __ExceptionOptionType<InvalidAssociation, __BaseException>);
|
|
5534
3975
|
}
|
|
5535
3976
|
/**
|
|
5536
|
-
* <p>A distribution Configuration and a list of tags to be associated with the
|
|
5537
|
-
* distribution.</p>
|
|
3977
|
+
* <p>A distribution Configuration and a list of tags to be associated with the distribution.</p>
|
|
5538
3978
|
* @public
|
|
5539
3979
|
*/
|
|
5540
3980
|
export interface DistributionConfigWithTags {
|
|
@@ -5635,10 +4075,7 @@ export interface ContentTypeProfiles {
|
|
|
5635
4075
|
*/
|
|
5636
4076
|
export interface ContentTypeProfileConfig {
|
|
5637
4077
|
/**
|
|
5638
|
-
* <p>The setting in a field-level encryption content type-profile mapping that specifies
|
|
5639
|
-
* what to do when an unknown content type is provided for the profile. If true, content is
|
|
5640
|
-
* forwarded without being encrypted when the content type is unknown. If false (the
|
|
5641
|
-
* default), an error is returned when the content type is unknown.</p>
|
|
4078
|
+
* <p>The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.</p>
|
|
5642
4079
|
* @public
|
|
5643
4080
|
*/
|
|
5644
4081
|
ForwardWhenContentTypeIsUnknown: boolean | undefined;
|
|
@@ -5670,8 +4107,7 @@ export interface QueryArgProfile {
|
|
|
5670
4107
|
*/
|
|
5671
4108
|
export interface QueryArgProfiles {
|
|
5672
4109
|
/**
|
|
5673
|
-
* <p>Number of profiles for query argument-profile mapping for field-level
|
|
5674
|
-
* encryption.</p>
|
|
4110
|
+
* <p>Number of profiles for query argument-profile mapping for field-level encryption.</p>
|
|
5675
4111
|
* @public
|
|
5676
4112
|
*/
|
|
5677
4113
|
Quantity: number | undefined;
|
|
@@ -5687,21 +4123,18 @@ export interface QueryArgProfiles {
|
|
|
5687
4123
|
*/
|
|
5688
4124
|
export interface QueryArgProfileConfig {
|
|
5689
4125
|
/**
|
|
5690
|
-
* <p>Flag to set if you want a request to be forwarded to the origin even if the profile
|
|
5691
|
-
* specified by the field-level encryption query argument, fle-profile, is unknown.</p>
|
|
4126
|
+
* <p>Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.</p>
|
|
5692
4127
|
* @public
|
|
5693
4128
|
*/
|
|
5694
4129
|
ForwardWhenQueryArgProfileIsUnknown: boolean | undefined;
|
|
5695
4130
|
/**
|
|
5696
|
-
* <p>Profiles specified for query argument-profile mapping for field-level
|
|
5697
|
-
* encryption.</p>
|
|
4131
|
+
* <p>Profiles specified for query argument-profile mapping for field-level encryption.</p>
|
|
5698
4132
|
* @public
|
|
5699
4133
|
*/
|
|
5700
4134
|
QueryArgProfiles?: QueryArgProfiles | undefined;
|
|
5701
4135
|
}
|
|
5702
4136
|
/**
|
|
5703
|
-
* <p>A complex data type that includes the profile configurations specified for field-level
|
|
5704
|
-
* encryption.</p>
|
|
4137
|
+
* <p>A complex data type that includes the profile configurations specified for field-level encryption.</p>
|
|
5705
4138
|
* @public
|
|
5706
4139
|
*/
|
|
5707
4140
|
export interface FieldLevelEncryptionConfig {
|
|
@@ -5711,21 +4144,17 @@ export interface FieldLevelEncryptionConfig {
|
|
|
5711
4144
|
*/
|
|
5712
4145
|
CallerReference: string | undefined;
|
|
5713
4146
|
/**
|
|
5714
|
-
* <p>An optional comment about the configuration. The comment cannot be longer than 128
|
|
5715
|
-
* characters.</p>
|
|
4147
|
+
* <p>An optional comment about the configuration. The comment cannot be longer than 128 characters.</p>
|
|
5716
4148
|
* @public
|
|
5717
4149
|
*/
|
|
5718
4150
|
Comment?: string | undefined;
|
|
5719
4151
|
/**
|
|
5720
|
-
* <p>A complex data type that specifies when to forward content if a profile isn't found
|
|
5721
|
-
* and the profile that can be provided as a query argument in a request.</p>
|
|
4152
|
+
* <p>A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.</p>
|
|
5722
4153
|
* @public
|
|
5723
4154
|
*/
|
|
5724
4155
|
QueryArgProfileConfig?: QueryArgProfileConfig | undefined;
|
|
5725
4156
|
/**
|
|
5726
|
-
* <p>A complex data type that specifies when to forward content if a content type isn't
|
|
5727
|
-
* recognized and profiles to use as by default in a request if a query argument doesn't
|
|
5728
|
-
* specify a profile to use.</p>
|
|
4157
|
+
* <p>A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.</p>
|
|
5729
4158
|
* @public
|
|
5730
4159
|
*/
|
|
5731
4160
|
ContentTypeProfileConfig?: ContentTypeProfileConfig | undefined;
|
|
@@ -5741,15 +4170,12 @@ export interface CreateFieldLevelEncryptionConfigRequest {
|
|
|
5741
4170
|
FieldLevelEncryptionConfig: FieldLevelEncryptionConfig | undefined;
|
|
5742
4171
|
}
|
|
5743
4172
|
/**
|
|
5744
|
-
* <p>A complex data type that includes the profile configurations and other options
|
|
5745
|
-
* specified for field-level encryption.</p>
|
|
4173
|
+
* <p>A complex data type that includes the profile configurations and other options specified for field-level encryption.</p>
|
|
5746
4174
|
* @public
|
|
5747
4175
|
*/
|
|
5748
4176
|
export interface FieldLevelEncryption {
|
|
5749
4177
|
/**
|
|
5750
|
-
* <p>The configuration ID for a field-level encryption configuration which includes a set
|
|
5751
|
-
* of profiles that specify certain selected data fields to be encrypted by specific public
|
|
5752
|
-
* keys.</p>
|
|
4178
|
+
* <p>The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.</p>
|
|
5753
4179
|
* @public
|
|
5754
4180
|
*/
|
|
5755
4181
|
Id: string | undefined;
|
|
@@ -5759,8 +4185,7 @@ export interface FieldLevelEncryption {
|
|
|
5759
4185
|
*/
|
|
5760
4186
|
LastModifiedTime: Date | undefined;
|
|
5761
4187
|
/**
|
|
5762
|
-
* <p>A complex data type that includes the profile configurations specified for field-level
|
|
5763
|
-
* encryption.</p>
|
|
4188
|
+
* <p>A complex data type that includes the profile configurations specified for field-level encryption.</p>
|
|
5764
4189
|
* @public
|
|
5765
4190
|
*/
|
|
5766
4191
|
FieldLevelEncryptionConfig: FieldLevelEncryptionConfig | undefined;
|
|
@@ -5780,8 +4205,7 @@ export interface CreateFieldLevelEncryptionConfigResult {
|
|
|
5780
4205
|
*/
|
|
5781
4206
|
Location?: string | undefined;
|
|
5782
4207
|
/**
|
|
5783
|
-
* <p>The current version of the field level encryption configuration. For example:
|
|
5784
|
-
* <code>E2QWRUHAPOMQZL</code>.</p>
|
|
4208
|
+
* <p>The current version of the field level encryption configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>
|
|
5785
4209
|
* @public
|
|
5786
4210
|
*/
|
|
5787
4211
|
ETag?: string | undefined;
|
|
@@ -5826,8 +4250,7 @@ export declare class QueryArgProfileEmpty extends __BaseException {
|
|
|
5826
4250
|
constructor(opts: __ExceptionOptionType<QueryArgProfileEmpty, __BaseException>);
|
|
5827
4251
|
}
|
|
5828
4252
|
/**
|
|
5829
|
-
* <p>The maximum number of configurations for field-level encryption have been
|
|
5830
|
-
* created.</p>
|
|
4253
|
+
* <p>The maximum number of configurations for field-level encryption have been created.</p>
|
|
5831
4254
|
* @public
|
|
5832
4255
|
*/
|
|
5833
4256
|
export declare class TooManyFieldLevelEncryptionConfigs extends __BaseException {
|
|
@@ -5840,8 +4263,7 @@ export declare class TooManyFieldLevelEncryptionConfigs extends __BaseException
|
|
|
5840
4263
|
constructor(opts: __ExceptionOptionType<TooManyFieldLevelEncryptionConfigs, __BaseException>);
|
|
5841
4264
|
}
|
|
5842
4265
|
/**
|
|
5843
|
-
* <p>The maximum number of content type profiles for field-level encryption have been
|
|
5844
|
-
* created.</p>
|
|
4266
|
+
* <p>The maximum number of content type profiles for field-level encryption have been created.</p>
|
|
5845
4267
|
* @public
|
|
5846
4268
|
*/
|
|
5847
4269
|
export declare class TooManyFieldLevelEncryptionContentTypeProfiles extends __BaseException {
|
|
@@ -5854,8 +4276,7 @@ export declare class TooManyFieldLevelEncryptionContentTypeProfiles extends __Ba
|
|
|
5854
4276
|
constructor(opts: __ExceptionOptionType<TooManyFieldLevelEncryptionContentTypeProfiles, __BaseException>);
|
|
5855
4277
|
}
|
|
5856
4278
|
/**
|
|
5857
|
-
* <p>The maximum number of query arg profiles for field-level encryption have been
|
|
5858
|
-
* created.</p>
|
|
4279
|
+
* <p>The maximum number of query arg profiles for field-level encryption have been created.</p>
|
|
5859
4280
|
* @public
|
|
5860
4281
|
*/
|
|
5861
4282
|
export declare class TooManyFieldLevelEncryptionQueryArgProfiles extends __BaseException {
|
|
@@ -5868,8 +4289,7 @@ export declare class TooManyFieldLevelEncryptionQueryArgProfiles extends __BaseE
|
|
|
5868
4289
|
constructor(opts: __ExceptionOptionType<TooManyFieldLevelEncryptionQueryArgProfiles, __BaseException>);
|
|
5869
4290
|
}
|
|
5870
4291
|
/**
|
|
5871
|
-
* <p>A complex data type that includes the field patterns to match for field-level
|
|
5872
|
-
* encryption.</p>
|
|
4292
|
+
* <p>A complex data type that includes the field patterns to match for field-level encryption.</p>
|
|
5873
4293
|
* @public
|
|
5874
4294
|
*/
|
|
5875
4295
|
export interface FieldPatterns {
|
|
@@ -5885,48 +4305,38 @@ export interface FieldPatterns {
|
|
|
5885
4305
|
Items?: string[] | undefined;
|
|
5886
4306
|
}
|
|
5887
4307
|
/**
|
|
5888
|
-
* <p>Complex data type for field-level encryption profiles that includes the encryption key
|
|
5889
|
-
* and field pattern specifications.</p>
|
|
4308
|
+
* <p>Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.</p>
|
|
5890
4309
|
* @public
|
|
5891
4310
|
*/
|
|
5892
4311
|
export interface EncryptionEntity {
|
|
5893
4312
|
/**
|
|
5894
|
-
* <p>The public key associated with a set of field-level encryption patterns, to be used
|
|
5895
|
-
* when encrypting the fields that match the patterns.</p>
|
|
4313
|
+
* <p>The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.</p>
|
|
5896
4314
|
* @public
|
|
5897
4315
|
*/
|
|
5898
4316
|
PublicKeyId: string | undefined;
|
|
5899
4317
|
/**
|
|
5900
|
-
* <p>The provider associated with the public key being used for encryption. This value must
|
|
5901
|
-
* also be provided with the private key for applications to be able to decrypt
|
|
5902
|
-
* data.</p>
|
|
4318
|
+
* <p>The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.</p>
|
|
5903
4319
|
* @public
|
|
5904
4320
|
*/
|
|
5905
4321
|
ProviderId: string | undefined;
|
|
5906
4322
|
/**
|
|
5907
|
-
* <p>Field patterns in a field-level encryption content type profile specify the fields
|
|
5908
|
-
* that you want to be encrypted. You can provide the full field name, or any beginning
|
|
5909
|
-
* characters followed by a wildcard (*). You can't overlap field patterns. For example,
|
|
5910
|
-
* you can't have both ABC* and AB*. Note that field patterns are case-sensitive.</p>
|
|
4323
|
+
* <p>Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.</p>
|
|
5911
4324
|
* @public
|
|
5912
4325
|
*/
|
|
5913
4326
|
FieldPatterns: FieldPatterns | undefined;
|
|
5914
4327
|
}
|
|
5915
4328
|
/**
|
|
5916
|
-
* <p>Complex data type for field-level encryption profiles that includes all of the
|
|
5917
|
-
* encryption entities.</p>
|
|
4329
|
+
* <p>Complex data type for field-level encryption profiles that includes all of the encryption entities.</p>
|
|
5918
4330
|
* @public
|
|
5919
4331
|
*/
|
|
5920
4332
|
export interface EncryptionEntities {
|
|
5921
4333
|
/**
|
|
5922
|
-
* <p>Number of field pattern items in a field-level encryption content type-profile
|
|
5923
|
-
* mapping.</p>
|
|
4334
|
+
* <p>Number of field pattern items in a field-level encryption content type-profile mapping.</p>
|
|
5924
4335
|
* @public
|
|
5925
4336
|
*/
|
|
5926
4337
|
Quantity: number | undefined;
|
|
5927
4338
|
/**
|
|
5928
|
-
* <p>An array of field patterns in a field-level encryption content type-profile mapping.
|
|
5929
|
-
* </p>
|
|
4339
|
+
* <p>An array of field patterns in a field-level encryption content type-profile mapping. </p>
|
|
5930
4340
|
* @public
|
|
5931
4341
|
*/
|
|
5932
4342
|
Items?: EncryptionEntity[] | undefined;
|
|
@@ -5947,15 +4357,12 @@ export interface FieldLevelEncryptionProfileConfig {
|
|
|
5947
4357
|
*/
|
|
5948
4358
|
CallerReference: string | undefined;
|
|
5949
4359
|
/**
|
|
5950
|
-
* <p>An optional comment for the field-level encryption profile. The comment cannot be
|
|
5951
|
-
* longer than 128 characters.</p>
|
|
4360
|
+
* <p>An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.</p>
|
|
5952
4361
|
* @public
|
|
5953
4362
|
*/
|
|
5954
4363
|
Comment?: string | undefined;
|
|
5955
4364
|
/**
|
|
5956
|
-
* <p>A complex data type of encryption entities for the field-level encryption profile that
|
|
5957
|
-
* include the public key ID, provider, and field patterns for specifying which fields to
|
|
5958
|
-
* encrypt with this key.</p>
|
|
4365
|
+
* <p>A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.</p>
|
|
5959
4366
|
* @public
|
|
5960
4367
|
*/
|
|
5961
4368
|
EncryptionEntities: EncryptionEntities | undefined;
|
|
@@ -5976,9 +4383,7 @@ export interface CreateFieldLevelEncryptionProfileRequest {
|
|
|
5976
4383
|
*/
|
|
5977
4384
|
export interface FieldLevelEncryptionProfile {
|
|
5978
4385
|
/**
|
|
5979
|
-
* <p>The ID for a field-level encryption profile configuration which includes a set of
|
|
5980
|
-
* profiles that specify certain selected data fields to be encrypted by specific public
|
|
5981
|
-
* keys.</p>
|
|
4386
|
+
* <p>The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.</p>
|
|
5982
4387
|
* @public
|
|
5983
4388
|
*/
|
|
5984
4389
|
Id: string | undefined;
|
|
@@ -5988,8 +4393,7 @@ export interface FieldLevelEncryptionProfile {
|
|
|
5988
4393
|
*/
|
|
5989
4394
|
LastModifiedTime: Date | undefined;
|
|
5990
4395
|
/**
|
|
5991
|
-
* <p>A complex data type that includes the profile name and the encryption entities for the
|
|
5992
|
-
* field-level encryption profile.</p>
|
|
4396
|
+
* <p>A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.</p>
|
|
5993
4397
|
* @public
|
|
5994
4398
|
*/
|
|
5995
4399
|
FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfig | undefined;
|
|
@@ -6009,8 +4413,7 @@ export interface CreateFieldLevelEncryptionProfileResult {
|
|
|
6009
4413
|
*/
|
|
6010
4414
|
Location?: string | undefined;
|
|
6011
4415
|
/**
|
|
6012
|
-
* <p>The current version of the field level encryption profile. For example:
|
|
6013
|
-
* <code>E2QWRUHAPOMQZL</code>.</p>
|
|
4416
|
+
* <p>The current version of the field level encryption profile. For example: <code>E2QWRUHAPOMQZL</code>.</p>
|
|
6014
4417
|
* @public
|
|
6015
4418
|
*/
|
|
6016
4419
|
ETag?: string | undefined;
|
|
@@ -6055,8 +4458,7 @@ export declare class NoSuchPublicKey extends __BaseException {
|
|
|
6055
4458
|
constructor(opts: __ExceptionOptionType<NoSuchPublicKey, __BaseException>);
|
|
6056
4459
|
}
|
|
6057
4460
|
/**
|
|
6058
|
-
* <p>The maximum number of encryption entities for field-level encryption have been
|
|
6059
|
-
* created.</p>
|
|
4461
|
+
* <p>The maximum number of encryption entities for field-level encryption have been created.</p>
|
|
6060
4462
|
* @public
|
|
6061
4463
|
*/
|
|
6062
4464
|
export declare class TooManyFieldLevelEncryptionEncryptionEntities extends __BaseException {
|
|
@@ -6069,8 +4471,7 @@ export declare class TooManyFieldLevelEncryptionEncryptionEntities extends __Bas
|
|
|
6069
4471
|
constructor(opts: __ExceptionOptionType<TooManyFieldLevelEncryptionEncryptionEntities, __BaseException>);
|
|
6070
4472
|
}
|
|
6071
4473
|
/**
|
|
6072
|
-
* <p>The maximum number of field patterns for field-level encryption have been
|
|
6073
|
-
* created.</p>
|
|
4474
|
+
* <p>The maximum number of field patterns for field-level encryption have been created.</p>
|
|
6074
4475
|
* @public
|
|
6075
4476
|
*/
|
|
6076
4477
|
export declare class TooManyFieldLevelEncryptionFieldPatterns extends __BaseException {
|
|
@@ -6165,15 +4566,12 @@ export interface CreateFunctionRequest {
|
|
|
6165
4566
|
*/
|
|
6166
4567
|
Name: string | undefined;
|
|
6167
4568
|
/**
|
|
6168
|
-
* <p>Configuration information about the function, including an optional comment and the
|
|
6169
|
-
* function's runtime.</p>
|
|
4569
|
+
* <p>Configuration information about the function, including an optional comment and the function's runtime.</p>
|
|
6170
4570
|
* @public
|
|
6171
4571
|
*/
|
|
6172
4572
|
FunctionConfig: FunctionConfig | undefined;
|
|
6173
4573
|
/**
|
|
6174
|
-
* <p>The function code. For more information about writing a CloudFront function, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html">Writing
|
|
6175
|
-
* function code for CloudFront Functions</a> in the
|
|
6176
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4574
|
+
* <p>The function code. For more information about writing a CloudFront function, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html">Writing function code for CloudFront Functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6177
4575
|
* @public
|
|
6178
4576
|
*/
|
|
6179
4577
|
FunctionCode: Uint8Array | undefined;
|
|
@@ -6196,18 +4594,12 @@ export type FunctionStage = (typeof FunctionStage)[keyof typeof FunctionStage];
|
|
|
6196
4594
|
*/
|
|
6197
4595
|
export interface FunctionMetadata {
|
|
6198
4596
|
/**
|
|
6199
|
-
* <p>The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the
|
|
6200
|
-
* function.</p>
|
|
4597
|
+
* <p>The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.</p>
|
|
6201
4598
|
* @public
|
|
6202
4599
|
*/
|
|
6203
4600
|
FunctionARN: string | undefined;
|
|
6204
4601
|
/**
|
|
6205
|
-
* <p>The stage that the function is in, either <code>DEVELOPMENT</code> or
|
|
6206
|
-
* <code>LIVE</code>.</p>
|
|
6207
|
-
* <p>When a function is in the <code>DEVELOPMENT</code> stage, you can test the function
|
|
6208
|
-
* with <code>TestFunction</code>, and update it with <code>UpdateFunction</code>.</p>
|
|
6209
|
-
* <p>When a function is in the <code>LIVE</code> stage, you can attach the function to a
|
|
6210
|
-
* distribution's cache behavior, using the function's ARN.</p>
|
|
4602
|
+
* <p>The stage that the function is in, either <code>DEVELOPMENT</code> or <code>LIVE</code>.</p> <p>When a function is in the <code>DEVELOPMENT</code> stage, you can test the function with <code>TestFunction</code>, and update it with <code>UpdateFunction</code>.</p> <p>When a function is in the <code>LIVE</code> stage, you can attach the function to a distribution's cache behavior, using the function's ARN.</p>
|
|
6211
4603
|
* @public
|
|
6212
4604
|
*/
|
|
6213
4605
|
Stage?: FunctionStage | undefined;
|
|
@@ -6258,8 +4650,7 @@ export interface CreateFunctionResult {
|
|
|
6258
4650
|
*/
|
|
6259
4651
|
FunctionSummary?: FunctionSummary | undefined;
|
|
6260
4652
|
/**
|
|
6261
|
-
* <p>The URL of the CloudFront function. Use the URL to manage the function with the CloudFront
|
|
6262
|
-
* API.</p>
|
|
4653
|
+
* <p>The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.</p>
|
|
6263
4654
|
* @public
|
|
6264
4655
|
*/
|
|
6265
4656
|
Location?: string | undefined;
|
|
@@ -6270,9 +4661,7 @@ export interface CreateFunctionResult {
|
|
|
6270
4661
|
ETag?: string | undefined;
|
|
6271
4662
|
}
|
|
6272
4663
|
/**
|
|
6273
|
-
* <p>A function with the same name already exists in this Amazon Web Services account. To create a
|
|
6274
|
-
* function, you must provide a unique name. To update an existing function, use
|
|
6275
|
-
* <code>UpdateFunction</code>.</p>
|
|
4664
|
+
* <p>A function with the same name already exists in this Amazon Web Services account. To create a function, you must provide a unique name. To update an existing function, use <code>UpdateFunction</code>.</p>
|
|
6276
4665
|
* @public
|
|
6277
4666
|
*/
|
|
6278
4667
|
export declare class FunctionAlreadyExists extends __BaseException {
|
|
@@ -6285,8 +4674,7 @@ export declare class FunctionAlreadyExists extends __BaseException {
|
|
|
6285
4674
|
constructor(opts: __ExceptionOptionType<FunctionAlreadyExists, __BaseException>);
|
|
6286
4675
|
}
|
|
6287
4676
|
/**
|
|
6288
|
-
* <p>The function is too large. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
6289
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4677
|
+
* <p>The function is too large. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6290
4678
|
* @public
|
|
6291
4679
|
*/
|
|
6292
4680
|
export declare class FunctionSizeLimitExceeded extends __BaseException {
|
|
@@ -6299,9 +4687,7 @@ export declare class FunctionSizeLimitExceeded extends __BaseException {
|
|
|
6299
4687
|
constructor(opts: __ExceptionOptionType<FunctionSizeLimitExceeded, __BaseException>);
|
|
6300
4688
|
}
|
|
6301
4689
|
/**
|
|
6302
|
-
* <p>You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more
|
|
6303
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
6304
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4690
|
+
* <p>You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6305
4691
|
* @public
|
|
6306
4692
|
*/
|
|
6307
4693
|
export declare class TooManyFunctions extends __BaseException {
|
|
@@ -6314,15 +4700,12 @@ export declare class TooManyFunctions extends __BaseException {
|
|
|
6314
4700
|
constructor(opts: __ExceptionOptionType<TooManyFunctions, __BaseException>);
|
|
6315
4701
|
}
|
|
6316
4702
|
/**
|
|
6317
|
-
* <p>A complex type that contains information about the objects that you want to
|
|
6318
|
-
* invalidate. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects">Specifying the Objects to Invalidate</a> in the
|
|
6319
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4703
|
+
* <p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6320
4704
|
* @public
|
|
6321
4705
|
*/
|
|
6322
4706
|
export interface Paths {
|
|
6323
4707
|
/**
|
|
6324
|
-
* <p>The number of invalidation paths specified for the objects that you want to
|
|
6325
|
-
* invalidate.</p>
|
|
4708
|
+
* <p>The number of invalidation paths specified for the objects that you want to invalidate.</p>
|
|
6326
4709
|
* @public
|
|
6327
4710
|
*/
|
|
6328
4711
|
Quantity: number | undefined;
|
|
@@ -6338,27 +4721,12 @@ export interface Paths {
|
|
|
6338
4721
|
*/
|
|
6339
4722
|
export interface InvalidationBatch {
|
|
6340
4723
|
/**
|
|
6341
|
-
* <p>A complex type that contains information about the objects that you want to
|
|
6342
|
-
* invalidate. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects">Specifying the Objects to Invalidate</a> in the
|
|
6343
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4724
|
+
* <p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6344
4725
|
* @public
|
|
6345
4726
|
*/
|
|
6346
4727
|
Paths: Paths | undefined;
|
|
6347
4728
|
/**
|
|
6348
|
-
* <p>A value that you specify to uniquely identify an invalidation request. CloudFront uses the
|
|
6349
|
-
* value to prevent you from accidentally resubmitting an identical request. Whenever you
|
|
6350
|
-
* create a new invalidation request, you must specify a new value for
|
|
6351
|
-
* <code>CallerReference</code> and change other values in the request as applicable.
|
|
6352
|
-
* One way to ensure that the value of <code>CallerReference</code> is unique is to use a
|
|
6353
|
-
* <code>timestamp</code>, for example, <code>20120301090000</code>.</p>
|
|
6354
|
-
* <p>If you make a second invalidation request with the same value for
|
|
6355
|
-
* <code>CallerReference</code>, and if the rest of the request is the same, CloudFront
|
|
6356
|
-
* doesn't create a new invalidation request. Instead, CloudFront returns information about the
|
|
6357
|
-
* invalidation request that you previously created with the same
|
|
6358
|
-
* <code>CallerReference</code>.</p>
|
|
6359
|
-
* <p>If <code>CallerReference</code> is a value you already sent in a previous invalidation
|
|
6360
|
-
* batch request but the content of any <code>Path</code> is different from the original
|
|
6361
|
-
* request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> error.</p>
|
|
4729
|
+
* <p>A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for <code>CallerReference</code> and change other values in the request as applicable. One way to ensure that the value of <code>CallerReference</code> is unique is to use a <code>timestamp</code>, for example, <code>20120301090000</code>.</p> <p>If you make a second invalidation request with the same value for <code>CallerReference</code>, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same <code>CallerReference</code>.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous invalidation batch request but the content of any <code>Path</code> is different from the original request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> error.</p>
|
|
6362
4730
|
* @public
|
|
6363
4731
|
*/
|
|
6364
4732
|
CallerReference: string | undefined;
|
|
@@ -6385,14 +4753,12 @@ export interface CreateInvalidationRequest {
|
|
|
6385
4753
|
*/
|
|
6386
4754
|
export interface Invalidation {
|
|
6387
4755
|
/**
|
|
6388
|
-
* <p>The identifier for the invalidation request. For example:
|
|
6389
|
-
* <code>IDFDVBD632BHDS5</code>.</p>
|
|
4756
|
+
* <p>The identifier for the invalidation request. For example: <code>IDFDVBD632BHDS5</code>.</p>
|
|
6390
4757
|
* @public
|
|
6391
4758
|
*/
|
|
6392
4759
|
Id: string | undefined;
|
|
6393
4760
|
/**
|
|
6394
|
-
* <p>The status of the invalidation request. When the invalidation batch is finished, the
|
|
6395
|
-
* status is <code>Completed</code>.</p>
|
|
4761
|
+
* <p>The status of the invalidation request. When the invalidation batch is finished, the status is <code>Completed</code>.</p>
|
|
6396
4762
|
* @public
|
|
6397
4763
|
*/
|
|
6398
4764
|
Status: string | undefined;
|
|
@@ -6413,8 +4779,7 @@ export interface Invalidation {
|
|
|
6413
4779
|
*/
|
|
6414
4780
|
export interface CreateInvalidationResult {
|
|
6415
4781
|
/**
|
|
6416
|
-
* <p>The fully qualified URI of the distribution and invalidation batch request, including
|
|
6417
|
-
* the <code>Invalidation ID</code>.</p>
|
|
4782
|
+
* <p>The fully qualified URI of the distribution and invalidation batch request, including the <code>Invalidation ID</code>.</p>
|
|
6418
4783
|
* @public
|
|
6419
4784
|
*/
|
|
6420
4785
|
Location?: string | undefined;
|
|
@@ -6425,8 +4790,7 @@ export interface CreateInvalidationResult {
|
|
|
6425
4790
|
Invalidation?: Invalidation | undefined;
|
|
6426
4791
|
}
|
|
6427
4792
|
/**
|
|
6428
|
-
* <p>You have exceeded the maximum number of allowable InProgress invalidation batch
|
|
6429
|
-
* requests, or invalidation objects.</p>
|
|
4793
|
+
* <p>You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.</p>
|
|
6430
4794
|
* @public
|
|
6431
4795
|
*/
|
|
6432
4796
|
export declare class TooManyInvalidationsInProgress extends __BaseException {
|
|
@@ -6469,8 +4833,7 @@ export interface CreateInvalidationForDistributionTenantResult {
|
|
|
6469
4833
|
Invalidation?: Invalidation | undefined;
|
|
6470
4834
|
}
|
|
6471
4835
|
/**
|
|
6472
|
-
* <p>A key group configuration.</p>
|
|
6473
|
-
* <p>A key group contains a list of public keys that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">CloudFront signed URLs and signed cookies</a>.</p>
|
|
4836
|
+
* <p>A key group configuration.</p> <p>A key group contains a list of public keys that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">CloudFront signed URLs and signed cookies</a>.</p>
|
|
6474
4837
|
* @public
|
|
6475
4838
|
*/
|
|
6476
4839
|
export interface KeyGroupConfig {
|
|
@@ -6485,8 +4848,7 @@ export interface KeyGroupConfig {
|
|
|
6485
4848
|
*/
|
|
6486
4849
|
Items: string[] | undefined;
|
|
6487
4850
|
/**
|
|
6488
|
-
* <p>A comment to describe the key group. The comment cannot be longer than 128
|
|
6489
|
-
* characters.</p>
|
|
4851
|
+
* <p>A comment to describe the key group. The comment cannot be longer than 128 characters.</p>
|
|
6490
4852
|
* @public
|
|
6491
4853
|
*/
|
|
6492
4854
|
Comment?: string | undefined;
|
|
@@ -6502,8 +4864,7 @@ export interface CreateKeyGroupRequest {
|
|
|
6502
4864
|
KeyGroupConfig: KeyGroupConfig | undefined;
|
|
6503
4865
|
}
|
|
6504
4866
|
/**
|
|
6505
|
-
* <p>A key group.</p>
|
|
6506
|
-
* <p>A key group contains a list of public keys that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">CloudFront signed URLs and signed cookies</a>.</p>
|
|
4867
|
+
* <p>A key group.</p> <p>A key group contains a list of public keys that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">CloudFront signed URLs and signed cookies</a>.</p>
|
|
6507
4868
|
* @public
|
|
6508
4869
|
*/
|
|
6509
4870
|
export interface KeyGroup {
|
|
@@ -6544,8 +4905,7 @@ export interface CreateKeyGroupResult {
|
|
|
6544
4905
|
ETag?: string | undefined;
|
|
6545
4906
|
}
|
|
6546
4907
|
/**
|
|
6547
|
-
* <p>A key group with this name already exists. You must provide a unique name. To modify
|
|
6548
|
-
* an existing key group, use <code>UpdateKeyGroup</code>.</p>
|
|
4908
|
+
* <p>A key group with this name already exists. You must provide a unique name. To modify an existing key group, use <code>UpdateKeyGroup</code>.</p>
|
|
6549
4909
|
* @public
|
|
6550
4910
|
*/
|
|
6551
4911
|
export declare class KeyGroupAlreadyExists extends __BaseException {
|
|
@@ -6558,9 +4918,7 @@ export declare class KeyGroupAlreadyExists extends __BaseException {
|
|
|
6558
4918
|
constructor(opts: __ExceptionOptionType<KeyGroupAlreadyExists, __BaseException>);
|
|
6559
4919
|
}
|
|
6560
4920
|
/**
|
|
6561
|
-
* <p>You have reached the maximum number of key groups for this Amazon Web Services account. For more
|
|
6562
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
6563
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4921
|
+
* <p>You have reached the maximum number of key groups for this Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6564
4922
|
* @public
|
|
6565
4923
|
*/
|
|
6566
4924
|
export declare class TooManyKeyGroups extends __BaseException {
|
|
@@ -6573,9 +4931,7 @@ export declare class TooManyKeyGroups extends __BaseException {
|
|
|
6573
4931
|
constructor(opts: __ExceptionOptionType<TooManyKeyGroups, __BaseException>);
|
|
6574
4932
|
}
|
|
6575
4933
|
/**
|
|
6576
|
-
* <p>The number of public keys in this key group is more than the maximum allowed. For more
|
|
6577
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
|
|
6578
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
4934
|
+
* <p>The number of public keys in this key group is more than the maximum allowed. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6579
4935
|
* @public
|
|
6580
4936
|
*/
|
|
6581
4937
|
export declare class TooManyPublicKeysInKeyGroup extends __BaseException {
|
|
@@ -6619,8 +4975,7 @@ export interface ImportSource {
|
|
|
6619
4975
|
*/
|
|
6620
4976
|
export interface CreateKeyValueStoreRequest {
|
|
6621
4977
|
/**
|
|
6622
|
-
* <p>The name of the key value store. The minimum length is 1 character and the maximum length is
|
|
6623
|
-
* 64 characters.</p>
|
|
4978
|
+
* <p>The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters.</p>
|
|
6624
4979
|
* @public
|
|
6625
4980
|
*/
|
|
6626
4981
|
Name: string | undefined;
|
|
@@ -6636,9 +4991,7 @@ export interface CreateKeyValueStoreRequest {
|
|
|
6636
4991
|
ImportSource?: ImportSource | undefined;
|
|
6637
4992
|
}
|
|
6638
4993
|
/**
|
|
6639
|
-
* <p>The key value store. Use this to separate data from function code, allowing you to update
|
|
6640
|
-
* data without having to publish a new version of a function. The key value store holds
|
|
6641
|
-
* keys and their corresponding values.</p>
|
|
4994
|
+
* <p>The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.</p>
|
|
6642
4995
|
* @public
|
|
6643
4996
|
*/
|
|
6644
4997
|
export interface KeyValueStore {
|
|
@@ -6724,15 +5077,13 @@ export type RealtimeMetricsSubscriptionStatus = (typeof RealtimeMetricsSubscript
|
|
|
6724
5077
|
*/
|
|
6725
5078
|
export interface RealtimeMetricsSubscriptionConfig {
|
|
6726
5079
|
/**
|
|
6727
|
-
* <p>A flag that indicates whether additional CloudWatch metrics are enabled for a given
|
|
6728
|
-
* CloudFront distribution.</p>
|
|
5080
|
+
* <p>A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
6729
5081
|
* @public
|
|
6730
5082
|
*/
|
|
6731
5083
|
RealtimeMetricsSubscriptionStatus: RealtimeMetricsSubscriptionStatus | undefined;
|
|
6732
5084
|
}
|
|
6733
5085
|
/**
|
|
6734
|
-
* <p>A monitoring subscription. This structure contains information about whether
|
|
6735
|
-
* additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
5086
|
+
* <p>A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
6736
5087
|
* @public
|
|
6737
5088
|
*/
|
|
6738
5089
|
export interface MonitoringSubscription {
|
|
@@ -6752,8 +5103,7 @@ export interface CreateMonitoringSubscriptionRequest {
|
|
|
6752
5103
|
*/
|
|
6753
5104
|
DistributionId: string | undefined;
|
|
6754
5105
|
/**
|
|
6755
|
-
* <p>A monitoring subscription. This structure contains information about whether additional CloudWatch
|
|
6756
|
-
* metrics are enabled for a given CloudFront distribution.</p>
|
|
5106
|
+
* <p>A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
6757
5107
|
* @public
|
|
6758
5108
|
*/
|
|
6759
5109
|
MonitoringSubscription: MonitoringSubscription | undefined;
|
|
@@ -6763,8 +5113,7 @@ export interface CreateMonitoringSubscriptionRequest {
|
|
|
6763
5113
|
*/
|
|
6764
5114
|
export interface CreateMonitoringSubscriptionResult {
|
|
6765
5115
|
/**
|
|
6766
|
-
* <p>A monitoring subscription. This structure contains information about whether
|
|
6767
|
-
* additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
5116
|
+
* <p>A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.</p>
|
|
6768
5117
|
* @public
|
|
6769
5118
|
*/
|
|
6770
5119
|
MonitoringSubscription?: MonitoringSubscription | undefined;
|
|
@@ -6836,42 +5185,12 @@ export interface OriginAccessControlConfig {
|
|
|
6836
5185
|
*/
|
|
6837
5186
|
Description?: string | undefined;
|
|
6838
5187
|
/**
|
|
6839
|
-
* <p>The signing protocol of the origin access control, which determines how CloudFront signs
|
|
6840
|
-
* (authenticates) requests. The only valid value is <code>sigv4</code>.</p>
|
|
5188
|
+
* <p>The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is <code>sigv4</code>.</p>
|
|
6841
5189
|
* @public
|
|
6842
5190
|
*/
|
|
6843
5191
|
SigningProtocol: OriginAccessControlSigningProtocols | undefined;
|
|
6844
5192
|
/**
|
|
6845
|
-
* <p>Specifies which requests CloudFront signs (adds authentication information to). Specify
|
|
6846
|
-
* <code>always</code> for the most common use case. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings">origin access control advanced settings</a> in the
|
|
6847
|
-
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
6848
|
-
* <p>This field can have one of the following values:</p>
|
|
6849
|
-
* <ul>
|
|
6850
|
-
* <li>
|
|
6851
|
-
* <p>
|
|
6852
|
-
* <code>always</code> – CloudFront signs all origin requests, overwriting the
|
|
6853
|
-
* <code>Authorization</code> header from the viewer request if one
|
|
6854
|
-
* exists.</p>
|
|
6855
|
-
* </li>
|
|
6856
|
-
* <li>
|
|
6857
|
-
* <p>
|
|
6858
|
-
* <code>never</code> – CloudFront doesn't sign any origin requests. This value turns
|
|
6859
|
-
* off origin access control for all origins in all distributions that use this
|
|
6860
|
-
* origin access control.</p>
|
|
6861
|
-
* </li>
|
|
6862
|
-
* <li>
|
|
6863
|
-
* <p>
|
|
6864
|
-
* <code>no-override</code> – If the viewer request doesn't contain the
|
|
6865
|
-
* <code>Authorization</code> header, then CloudFront signs the origin request. If
|
|
6866
|
-
* the viewer request contains the <code>Authorization</code> header, then CloudFront
|
|
6867
|
-
* doesn't sign the origin request and instead passes along the
|
|
6868
|
-
* <code>Authorization</code> header from the viewer request. <b>WARNING: To pass along the <code>Authorization</code> header
|
|
6869
|
-
* from the viewer request, you <i>must</i> add the
|
|
6870
|
-
* <code>Authorization</code> header to a <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">cache policy</a> for all cache behaviors that
|
|
6871
|
-
* use origins associated with this origin access control.</b>
|
|
6872
|
-
* </p>
|
|
6873
|
-
* </li>
|
|
6874
|
-
* </ul>
|
|
5193
|
+
* <p>Specifies which requests CloudFront signs (adds authentication information to). Specify <code>always</code> for the most common use case. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings">origin access control advanced settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>This field can have one of the following values:</p> <ul> <li> <p> <code>always</code> – CloudFront signs all origin requests, overwriting the <code>Authorization</code> header from the viewer request if one exists.</p> </li> <li> <p> <code>never</code> – 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.</p> </li> <li> <p> <code>no-override</code> – If the viewer request doesn't contain the <code>Authorization</code> header, then CloudFront signs the origin request. If the viewer request contains the <code>Authorization</code> header, then CloudFront doesn't sign the origin request and instead passes along the <code>Authorization</code> header from the viewer request. <b>WARNING: To pass along the <code>Authorization</code> header from the viewer request, you <i>must</i> add the <code>Authorization</code> header to a <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">cache policy</a> for all cache behaviors that use origins associated with this origin access control.</b> </p> </li> </ul>
|
|
6875
5194
|
* @public
|
|
6876
5195
|
*/
|
|
6877
5196
|
SigningBehavior: OriginAccessControlSigningBehaviors | undefined;
|