@aws-sdk/client-cloudfront 3.231.0 → 3.233.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/dist-types/CloudFront.d.ts +242 -244
- package/dist-types/CloudFrontClient.d.ts +1 -1
- package/dist-types/commands/AssociateAliasCommand.d.ts +2 -2
- package/dist-types/commands/CopyDistributionCommand.d.ts +2 -2
- package/dist-types/commands/CreateCachePolicyCommand.d.ts +10 -10
- package/dist-types/commands/CreateContinuousDeploymentPolicyCommand.d.ts +5 -5
- package/dist-types/commands/CreateFunctionCommand.d.ts +5 -5
- package/dist-types/commands/CreateInvalidationCommand.d.ts +1 -1
- package/dist-types/commands/CreateKeyGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateMonitoringSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateOriginAccessControlCommand.d.ts +2 -2
- package/dist-types/commands/CreateOriginRequestPolicyCommand.d.ts +11 -11
- package/dist-types/commands/CreateRealtimeLogConfigCommand.d.ts +2 -2
- package/dist-types/commands/CreateResponseHeadersPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteCachePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteCloudFrontOriginAccessIdentityCommand.d.ts +1 -1
- package/dist-types/commands/DeleteContinuousDeploymentPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDistributionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFunctionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteKeyGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteOriginAccessControlCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOriginRequestPolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRealtimeLogConfigCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResponseHeadersPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteStreamingDistributionCommand.d.ts +19 -20
- package/dist-types/commands/DescribeFunctionCommand.d.ts +3 -3
- package/dist-types/commands/GetCachePolicyCommand.d.ts +7 -7
- package/dist-types/commands/GetCachePolicyConfigCommand.d.ts +2 -2
- package/dist-types/commands/GetCloudFrontOriginAccessIdentityCommand.d.ts +1 -1
- package/dist-types/commands/GetCloudFrontOriginAccessIdentityConfigCommand.d.ts +1 -1
- package/dist-types/commands/GetContinuousDeploymentPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetDistributionConfigCommand.d.ts +1 -1
- package/dist-types/commands/GetFunctionCommand.d.ts +1 -1
- package/dist-types/commands/GetInvalidationCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyGroupCommand.d.ts +2 -2
- package/dist-types/commands/GetKeyGroupConfigCommand.d.ts +2 -2
- package/dist-types/commands/GetOriginRequestPolicyCommand.d.ts +8 -8
- package/dist-types/commands/GetOriginRequestPolicyConfigCommand.d.ts +3 -3
- package/dist-types/commands/GetRealtimeLogConfigCommand.d.ts +1 -1
- package/dist-types/commands/GetResponseHeadersPolicyCommand.d.ts +4 -4
- package/dist-types/commands/GetResponseHeadersPolicyConfigCommand.d.ts +3 -3
- package/dist-types/commands/GetStreamingDistributionConfigCommand.d.ts +1 -1
- package/dist-types/commands/ListCachePoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListConflictingAliasesCommand.d.ts +4 -4
- package/dist-types/commands/ListContinuousDeploymentPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListDistributionsByCachePolicyIdCommand.d.ts +2 -2
- package/dist-types/commands/ListDistributionsByKeyGroupCommand.d.ts +1 -1
- package/dist-types/commands/ListDistributionsByOriginRequestPolicyIdCommand.d.ts +2 -2
- package/dist-types/commands/ListDistributionsByRealtimeLogConfigCommand.d.ts +4 -4
- package/dist-types/commands/ListDistributionsByResponseHeadersPolicyIdCommand.d.ts +2 -2
- package/dist-types/commands/ListFunctionsCommand.d.ts +2 -2
- package/dist-types/commands/ListInvalidationsCommand.d.ts +1 -1
- package/dist-types/commands/ListKeyGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListOriginAccessControlsCommand.d.ts +1 -1
- package/dist-types/commands/ListOriginRequestPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListRealtimeLogConfigsCommand.d.ts +2 -2
- package/dist-types/commands/ListResponseHeadersPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListStreamingDistributionsCommand.d.ts +1 -1
- package/dist-types/commands/PublishFunctionCommand.d.ts +3 -3
- package/dist-types/commands/TestFunctionCommand.d.ts +4 -4
- package/dist-types/commands/UpdateCachePolicyCommand.d.ts +9 -9
- package/dist-types/commands/UpdateCloudFrontOriginAccessIdentityCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContinuousDeploymentPolicyCommand.d.ts +9 -9
- package/dist-types/commands/UpdateDistributionCommand.d.ts +15 -16
- package/dist-types/commands/UpdateDistributionWithStagingConfigCommand.d.ts +4 -4
- package/dist-types/commands/UpdateFieldLevelEncryptionConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFieldLevelEncryptionProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFunctionCommand.d.ts +3 -3
- package/dist-types/commands/UpdateKeyGroupCommand.d.ts +9 -9
- package/dist-types/commands/UpdateOriginRequestPolicyCommand.d.ts +9 -9
- package/dist-types/commands/UpdateRealtimeLogConfigCommand.d.ts +10 -10
- package/dist-types/commands/UpdateResponseHeadersPolicyCommand.d.ts +9 -9
- package/dist-types/commands/UpdateStreamingDistributionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +667 -674
- package/dist-types/models/models_1.d.ts +191 -191
- package/package.json +1 -1
|
@@ -230,7 +230,7 @@ export interface CloudFrontClientResolvedConfig extends CloudFrontClientResolved
|
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
232
|
* <fullname>Amazon CloudFront</fullname>
|
|
233
|
-
*
|
|
233
|
+
* <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers
|
|
234
234
|
* who need detailed information about CloudFront API actions, data types, and errors. For
|
|
235
235
|
* detailed information about CloudFront features, see the
|
|
236
236
|
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
@@ -10,11 +10,11 @@ export interface AssociateAliasCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront
|
|
12
12
|
* distribution.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>With this operation you can move an alias that's already in use on a CloudFront distribution
|
|
14
14
|
* to a different distribution in one step. This prevents the downtime that could occur if
|
|
15
15
|
* you first remove the alias from one distribution and then separately add the alias to
|
|
16
16
|
* another distribution.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>To use this operation to associate an alias with a distribution, you provide the alias
|
|
18
18
|
* and the ID of the target distribution for the alias. For more information, including how
|
|
19
19
|
* to set up the target distribution, prerequisites that you must complete, and other
|
|
20
20
|
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move">Moving an alternate domain name to a different
|
|
@@ -11,8 +11,8 @@ export interface CopyDistributionCommandOutput extends CopyDistributionResult, _
|
|
|
11
11
|
* <p>Creates a staging distribution using the configuration of the provided primary
|
|
12
12
|
* distribution. A staging distribution is a copy of an existing distribution (called the
|
|
13
13
|
* primary distribution) that you can use in a continuous deployment workflow.</p>
|
|
14
|
-
*
|
|
15
|
-
* to modify the staging distribution
|
|
14
|
+
* <p>After you create a staging distribution, you can use <code>UpdateDistribution</code>
|
|
15
|
+
* to modify the staging distribution's configuration. Then you can use
|
|
16
16
|
* <code>CreateContinuousDeploymentPolicy</code> to incrementally move traffic to the
|
|
17
17
|
* staging distribution.</p>
|
|
18
18
|
* @example
|
|
@@ -9,27 +9,27 @@ export interface CreateCachePolicyCommandOutput extends CreateCachePolicyResult,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a cache policy.</p>
|
|
12
|
-
*
|
|
13
|
-
* When it
|
|
12
|
+
* <p>After you create a cache policy, you can attach it to one or more cache behaviors.
|
|
13
|
+
* When it's attached to a cache behavior, the cache policy determines the
|
|
14
14
|
* following:</p>
|
|
15
|
-
*
|
|
15
|
+
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>The values that CloudFront includes in the <i>cache key</i>. These
|
|
18
18
|
* values can include HTTP headers, cookies, and URL query strings. CloudFront uses the
|
|
19
19
|
* cache key to find an object in its cache that it can return to the
|
|
20
20
|
* viewer.</p>
|
|
21
|
-
*
|
|
21
|
+
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>The default, minimum, and maximum time to live (TTL) values that you want
|
|
24
24
|
* objects to stay in the CloudFront cache.</p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* </ul>
|
|
27
|
-
*
|
|
27
|
+
* <p>The headers, cookies, and query strings that are included in the cache key are
|
|
28
28
|
* automatically included in requests that CloudFront sends to the origin. CloudFront sends a request
|
|
29
|
-
* when it can
|
|
29
|
+
* when it can't find an object in its cache that matches the request's cache key. If you
|
|
30
30
|
* want to send values to the origin but <i>not</i> include them in the cache
|
|
31
31
|
* key, use <code>OriginRequestPolicy</code>.</p>
|
|
32
|
-
*
|
|
32
|
+
* <p>For more information about cache policies, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">Controlling the cache key</a> in the
|
|
33
33
|
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,13 +10,13 @@ export interface CreateContinuousDeploymentPolicyCommandOutput extends CreateCon
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a continuous deployment policy that distributes traffic for a custom domain
|
|
12
12
|
* name to two different CloudFront distributions.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To use a continuous deployment policy, first use <code>CopyDistribution</code> to
|
|
14
14
|
* create a staging distribution, then use <code>UpdateDistribution</code> to modify the
|
|
15
|
-
* staging distribution
|
|
16
|
-
*
|
|
15
|
+
* staging distribution's configuration.</p>
|
|
16
|
+
* <p>After you create and update a staging distribution, you can use a continuous
|
|
17
17
|
* deployment policy to incrementally move traffic to the staging distribution. This
|
|
18
|
-
* workflow enables you to test changes to a distribution
|
|
19
|
-
* of your domain
|
|
18
|
+
* workflow enables you to test changes to a distribution's configuration before moving all
|
|
19
|
+
* of your domain's production traffic to the new configuration.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -9,16 +9,16 @@ export interface CreateFunctionCommandOutput extends CreateFunctionResult, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a CloudFront function.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To create a function, you provide the function code and some configuration information
|
|
13
13
|
* about the function. The response contains an Amazon Resource Name (ARN) that uniquely
|
|
14
14
|
* identifies the function.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>When you create a function, it's in the <code>DEVELOPMENT</code> stage. In this stage,
|
|
16
16
|
* you can test the function with <code>TestFunction</code>, and update it with
|
|
17
17
|
* <code>UpdateFunction</code>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>When you're ready to use your function with a CloudFront distribution, use
|
|
19
19
|
* <code>PublishFunction</code> to copy the function from the <code>DEVELOPMENT</code>
|
|
20
|
-
* stage to <code>LIVE</code>. When it
|
|
21
|
-
* distribution
|
|
20
|
+
* stage to <code>LIVE</code>. When it's live, you can attach the function to a
|
|
21
|
+
* distribution's cache behavior, using the function's ARN.</p>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
24
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface CreateInvalidationCommandInput extends CreateInvalidationReques
|
|
|
8
8
|
export interface CreateInvalidationCommandOutput extends CreateInvalidationResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Create a new invalidation
|
|
11
|
+
* <p>Create a new invalidation.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateKeyGroupCommandOutput extends CreateKeyGroupResult, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a key group 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>
|
|
12
|
-
*
|
|
12
|
+
* <p>To create a key group, you must specify at least one public key for the key group.
|
|
13
13
|
* After you create a key group, you can reference it from one or more cache behaviors.
|
|
14
14
|
* When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed
|
|
15
15
|
* cookies for all requests that match the cache behavior. The URLs or cookies must be
|
|
@@ -10,7 +10,7 @@ export interface CreateMonitoringSubscriptionCommandOutput extends CreateMonitor
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Enables additional CloudWatch metrics for the specified CloudFront distribution. The
|
|
12
12
|
* additional metrics incur an additional cost.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional">Viewing additional CloudFront distribution metrics</a> in
|
|
14
14
|
* the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,9 +11,9 @@ export interface CreateOriginAccessControlCommandOutput extends CreateOriginAcce
|
|
|
11
11
|
* <p>Creates a new origin access control in CloudFront. After you create an origin access
|
|
12
12
|
* control, you can add it to an origin in a CloudFront distribution so that CloudFront sends
|
|
13
13
|
* authenticated (signed) requests to the origin.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket
|
|
15
15
|
* so that viewers (users) can access the content in the bucket only through CloudFront.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>For more information about using a CloudFront origin access control, 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
|
|
17
17
|
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,31 +9,31 @@ export interface CreateOriginRequestPolicyCommandOutput extends CreateOriginRequ
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an origin request policy.</p>
|
|
12
|
-
*
|
|
13
|
-
* behaviors. When it
|
|
12
|
+
* <p>After you create an origin request policy, you can attach it to one or more cache
|
|
13
|
+
* behaviors. When it's attached to a cache behavior, the origin request policy determines
|
|
14
14
|
* the values that CloudFront includes in requests that it sends to the origin. Each request that
|
|
15
15
|
* CloudFront sends to the origin includes the following:</p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>The request body and the URL path (without the domain name) from the viewer
|
|
19
19
|
* request.</p>
|
|
20
|
-
*
|
|
20
|
+
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>The headers that CloudFront automatically includes in every origin request,
|
|
23
23
|
* including <code>Host</code>, <code>User-Agent</code>, and
|
|
24
24
|
* <code>X-Amz-Cf-Id</code>.</p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>All HTTP headers, cookies, and URL query strings that are specified in the
|
|
28
28
|
* cache policy or the origin request policy. These can include items from the
|
|
29
29
|
* viewer request and, in the case of headers, additional ones that are added by
|
|
30
30
|
* CloudFront.</p>
|
|
31
|
-
*
|
|
31
|
+
* </li>
|
|
32
32
|
* </ul>
|
|
33
|
-
*
|
|
33
|
+
* <p>CloudFront sends a request when it can't find a valid object in its cache that matches the
|
|
34
34
|
* request. If you want to send values to the origin and also include them in the cache
|
|
35
35
|
* key, use <code>CachePolicy</code>.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>For more information about origin request policies, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html">Controlling origin requests</a> in the
|
|
37
37
|
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,9 +9,9 @@ export interface CreateRealtimeLogConfigCommandOutput extends CreateRealtimeLogC
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a real-time log configuration.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>After you create a real-time log configuration, you can attach it to one or more cache
|
|
13
13
|
* behaviors to send real-time log data to the specified Amazon Kinesis data stream.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information about real-time log configurations, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the
|
|
15
15
|
* <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,11 +9,11 @@ export interface CreateResponseHeadersPolicyCommandOutput extends CreateResponse
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a response headers policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A response headers policy contains information about a set of HTTP response headers
|
|
13
13
|
* and their values. To create a response headers policy, you provide some metadata about
|
|
14
14
|
* the policy, and a set of configurations that specify the response headers.</p>
|
|
15
|
-
*
|
|
16
|
-
* more cache behaviors in a CloudFront distribution. When it
|
|
15
|
+
* <p>After you create a response headers policy, you can use its ID to attach it to one or
|
|
16
|
+
* more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior,
|
|
17
17
|
* CloudFront adds the headers in the policy to HTTP responses that it sends for requests that
|
|
18
18
|
* match the cache behavior.</p>
|
|
19
19
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface DeleteCachePolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a cache policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a cache policy if it's attached to a cache behavior. First update
|
|
13
13
|
* your distributions to remove the cache policy from all cache behaviors, then delete the
|
|
14
14
|
* cache policy.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete a cache policy, you must provide the policy's identifier and version. To get
|
|
16
16
|
* these values, you can use <code>ListCachePolicies</code> or
|
|
17
17
|
* <code>GetCachePolicy</code>.</p>
|
|
18
18
|
* @example
|
|
@@ -8,7 +8,7 @@ export interface DeleteCloudFrontOriginAccessIdentityCommandInput extends Delete
|
|
|
8
8
|
export interface DeleteCloudFrontOriginAccessIdentityCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Delete an origin access identity
|
|
11
|
+
* <p>Delete an origin access identity.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteContinuousDeploymentPolicyCommandOutput extends __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a continuous deployment policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a continuous deployment policy that's attached to a primary
|
|
13
13
|
* distribution. First update your distribution to remove the continuous deployment policy,
|
|
14
14
|
* then you can delete the policy.</p>
|
|
15
15
|
* @example
|
|
@@ -8,7 +8,7 @@ export interface DeleteDistributionCommandInput extends DeleteDistributionReques
|
|
|
8
8
|
export interface DeleteDistributionCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Delete a distribution
|
|
11
|
+
* <p>Delete a distribution.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -9,10 +9,10 @@ export interface DeleteFunctionCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a CloudFront function.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a function if it's associated with a cache behavior. First, update
|
|
13
13
|
* your distributions to remove the function association from all cache behaviors, then
|
|
14
14
|
* delete the function.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete a function, you must provide the function's name and version
|
|
16
16
|
* (<code>ETag</code> value). To get these values, you can use
|
|
17
17
|
* <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
|
|
18
18
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface DeleteKeyGroupCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a key group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a key group that is referenced in a cache behavior. First update
|
|
13
13
|
* your distributions to remove the key group from all cache behaviors, then delete the key
|
|
14
14
|
* group.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete a key group, you must provide the key group's identifier and version. To get
|
|
16
16
|
* these values, use <code>ListKeyGroups</code> followed by <code>GetKeyGroup</code> or
|
|
17
17
|
* <code>GetKeyGroupConfig</code>.</p>
|
|
18
18
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface DeleteOriginAccessControlCommandOutput extends __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a CloudFront origin access control.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete an origin access control if it's in use. First, update all
|
|
13
13
|
* distributions to remove the origin access control from all origins, then delete the
|
|
14
14
|
* origin access control.</p>
|
|
15
15
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface DeleteOriginRequestPolicyCommandOutput extends __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an origin request policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete an origin request policy if it's attached to any cache behaviors.
|
|
13
13
|
* First update your distributions to remove the origin request policy from all cache
|
|
14
14
|
* behaviors, then delete the origin request policy.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete an origin request policy, you must provide the policy's identifier and
|
|
16
16
|
* version. To get the identifier, you can use <code>ListOriginRequestPolicies</code> or
|
|
17
17
|
* <code>GetOriginRequestPolicy</code>.</p>
|
|
18
18
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface DeleteRealtimeLogConfigCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a real-time log configuration.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a real-time log configuration if it's attached to a cache behavior.
|
|
13
13
|
* First update your distributions to remove the real-time log configuration from all cache
|
|
14
14
|
* behaviors, then delete the real-time log configuration.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete a real-time log configuration, you can provide the configuration's name or
|
|
16
16
|
* its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront
|
|
17
17
|
* uses the name to identify the real-time log configuration to delete.</p>
|
|
18
18
|
* @example
|
|
@@ -9,12 +9,12 @@ export interface DeleteResponseHeadersPolicyCommandOutput extends __MetadataBear
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a response headers policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete a response headers policy if it's attached to a cache behavior.
|
|
13
13
|
* First update your distributions to remove the response headers policy from all cache
|
|
14
14
|
* behaviors, then delete the response headers policy.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To delete a response headers policy, you must provide the policy's identifier and
|
|
16
16
|
* version. To get these values, you can use <code>ListResponseHeadersPolicies</code> or
|
|
17
|
-
* <code>GetResponseHeadersPolicy</code
|
|
17
|
+
* <code>GetResponseHeadersPolicy</code>.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -10,53 +10,52 @@ export interface DeleteStreamingDistributionCommandOutput extends __MetadataBear
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API,
|
|
12
12
|
* perform the following steps.</p>
|
|
13
|
-
*
|
|
14
|
-
* <p>
|
|
13
|
+
* <p>
|
|
15
14
|
* <b>To delete an RTMP distribution using the CloudFront
|
|
16
15
|
* API</b>:</p>
|
|
17
|
-
*
|
|
16
|
+
* <ol>
|
|
18
17
|
* <li>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
18
|
+
* <p>Disable the RTMP distribution.</p>
|
|
19
|
+
* </li>
|
|
21
20
|
* <li>
|
|
22
|
-
*
|
|
21
|
+
* <p>Submit a <code>GET Streaming Distribution Config</code> request to get the
|
|
23
22
|
* current configuration and the <code>Etag</code> header for the distribution.
|
|
24
23
|
* </p>
|
|
25
|
-
*
|
|
24
|
+
* </li>
|
|
26
25
|
* <li>
|
|
27
|
-
*
|
|
26
|
+
* <p>Update the XML document that was returned in the response to your <code>GET
|
|
28
27
|
* Streaming Distribution Config</code> request to change the value of
|
|
29
28
|
* <code>Enabled</code> to <code>false</code>.</p>
|
|
30
|
-
*
|
|
29
|
+
* </li>
|
|
31
30
|
* <li>
|
|
32
|
-
*
|
|
31
|
+
* <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the
|
|
33
32
|
* configuration for your distribution. In the request body, include the XML
|
|
34
33
|
* document that you updated in Step 3. Then set the value of the HTTP
|
|
35
34
|
* <code>If-Match</code> header to the value of the <code>ETag</code> header
|
|
36
35
|
* that CloudFront returned when you submitted the <code>GET Streaming Distribution
|
|
37
36
|
* Config</code> request in Step 2.</p>
|
|
38
|
-
*
|
|
37
|
+
* </li>
|
|
39
38
|
* <li>
|
|
40
|
-
*
|
|
39
|
+
* <p>Review the response to the <code>PUT Streaming Distribution Config</code>
|
|
41
40
|
* request to confirm that the distribution was successfully disabled.</p>
|
|
42
|
-
*
|
|
41
|
+
* </li>
|
|
43
42
|
* <li>
|
|
44
|
-
*
|
|
43
|
+
* <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm
|
|
45
44
|
* that your changes have propagated. When propagation is complete, the value of
|
|
46
45
|
* <code>Status</code> is <code>Deployed</code>.</p>
|
|
47
|
-
*
|
|
46
|
+
* </li>
|
|
48
47
|
* <li>
|
|
49
|
-
*
|
|
48
|
+
* <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of
|
|
50
49
|
* the HTTP <code>If-Match</code> header to the value of the <code>ETag</code>
|
|
51
50
|
* header that CloudFront returned when you submitted the <code>GET Streaming
|
|
52
51
|
* Distribution Config</code> request in Step 2.</p>
|
|
53
|
-
*
|
|
52
|
+
* </li>
|
|
54
53
|
* <li>
|
|
55
|
-
*
|
|
54
|
+
* <p>Review the response to your <code>DELETE Streaming Distribution</code> request
|
|
56
55
|
* to confirm that the distribution was successfully deleted.</p>
|
|
57
|
-
*
|
|
56
|
+
* </li>
|
|
58
57
|
* </ol>
|
|
59
|
-
*
|
|
58
|
+
* <p>For information about deleting a distribution using the CloudFront console, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html">Deleting a
|
|
60
59
|
* Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
|
|
61
60
|
* @example
|
|
62
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,9 +9,9 @@ export interface DescribeFunctionCommandOutput extends DescribeFunctionResult, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets configuration information and metadata about a CloudFront function, but not the
|
|
12
|
-
* function
|
|
13
|
-
*
|
|
14
|
-
* function
|
|
12
|
+
* function's code. To get a function's code, use <code>GetFunction</code>.</p>
|
|
13
|
+
* <p>To get configuration information and metadata about a function, you must provide the
|
|
14
|
+
* function's name and stage. To get these values, you can use
|
|
15
15
|
* <code>ListFunctions</code>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,16 +9,16 @@ export interface GetCachePolicyCommandOutput extends GetCachePolicyResult, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets a cache policy, including the following metadata:</p>
|
|
12
|
-
*
|
|
12
|
+
* <ul>
|
|
13
13
|
* <li>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>The policy's identifier.</p>
|
|
15
|
+
* </li>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* <p>The date and time when the policy was last modified.</p>
|
|
18
|
+
* </li>
|
|
19
19
|
* </ul>
|
|
20
|
-
*
|
|
21
|
-
* is attached to a distribution
|
|
20
|
+
* <p>To get a cache policy, you must provide the policy's identifier. If the cache policy
|
|
21
|
+
* is attached to a distribution's cache behavior, you can get the policy's identifier
|
|
22
22
|
* using <code>ListDistributions</code> or <code>GetDistribution</code>. If the cache
|
|
23
23
|
* policy is not attached to a cache behavior, you can get the identifier using
|
|
24
24
|
* <code>ListCachePolicies</code>.</p>
|
|
@@ -9,8 +9,8 @@ export interface GetCachePolicyConfigCommandOutput extends GetCachePolicyConfigR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets a cache policy configuration.</p>
|
|
12
|
-
*
|
|
13
|
-
* cache policy is attached to a distribution
|
|
12
|
+
* <p>To get a cache policy configuration, you must provide the policy's identifier. If the
|
|
13
|
+
* cache policy is attached to a distribution's cache behavior, you can get the policy's
|
|
14
14
|
* identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the
|
|
15
15
|
* cache policy is not attached to a cache behavior, you can get the identifier using
|
|
16
16
|
* <code>ListCachePolicies</code>.</p>
|
|
@@ -8,7 +8,7 @@ export interface GetCloudFrontOriginAccessIdentityCommandInput extends GetCloudF
|
|
|
8
8
|
export interface GetCloudFrontOriginAccessIdentityCommandOutput extends GetCloudFrontOriginAccessIdentityResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Get the information about an origin access identity
|
|
11
|
+
* <p>Get the information about an origin access identity.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface GetCloudFrontOriginAccessIdentityConfigCommandInput extends Get
|
|
|
8
8
|
export interface GetCloudFrontOriginAccessIdentityConfigCommandOutput extends GetCloudFrontOriginAccessIdentityConfigResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Get the configuration information about an origin access identity
|
|
11
|
+
* <p>Get the configuration information about an origin access identity.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface GetContinuousDeploymentPolicyCommandInput extends GetContinuous
|
|
|
8
8
|
export interface GetContinuousDeploymentPolicyCommandOutput extends GetContinuousDeploymentPolicyResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Gets a continuous deployment policy, including metadata (the policy
|
|
11
|
+
* <p>Gets a continuous deployment policy, including metadata (the policy's identifier and
|
|
12
12
|
* the date and time when the policy was last modified).</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface GetDistributionConfigCommandInput extends GetDistributionConfig
|
|
|
8
8
|
export interface GetDistributionConfigCommandOutput extends GetDistributionConfigResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Get the configuration information about a distribution
|
|
11
|
+
* <p>Get the configuration information about a distribution.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface GetFunctionCommandOutput extends GetFunctionResult, __MetadataB
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets the code of a CloudFront function. To get configuration information and metadata about
|
|
12
12
|
* a function, use <code>DescribeFunction</code>.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get a function's code, you must provide the function's name and stage. To get these
|
|
14
14
|
* values, you can use <code>ListFunctions</code>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface GetInvalidationCommandInput extends GetInvalidationRequest {
|
|
|
8
8
|
export interface GetInvalidationCommandOutput extends GetInvalidationResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Get the information about an invalidation
|
|
11
|
+
* <p>Get the information about an invalidation.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -10,8 +10,8 @@ export interface GetKeyGroupCommandOutput extends GetKeyGroupResult, __MetadataB
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets a key group, including the date and time when the key group was last
|
|
12
12
|
* modified.</p>
|
|
13
|
-
*
|
|
14
|
-
* referenced in a distribution
|
|
13
|
+
* <p>To get a key group, you must provide the key group's identifier. If the key group is
|
|
14
|
+
* referenced in a distribution's cache behavior, you can get the key group's identifier
|
|
15
15
|
* using <code>ListDistributions</code> or <code>GetDistribution</code>. If the key group
|
|
16
16
|
* is not referenced in a cache behavior, you can get the identifier using
|
|
17
17
|
* <code>ListKeyGroups</code>.</p>
|
|
@@ -9,8 +9,8 @@ export interface GetKeyGroupConfigCommandOutput extends GetKeyGroupConfigResult,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets a key group configuration.</p>
|
|
12
|
-
*
|
|
13
|
-
* key group is referenced in a distribution
|
|
12
|
+
* <p>To get a key group configuration, you must provide the key group's identifier. If the
|
|
13
|
+
* key group is referenced in a distribution's cache behavior, you can get the key group's
|
|
14
14
|
* identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the
|
|
15
15
|
* key group is not referenced in a cache behavior, you can get the identifier using
|
|
16
16
|
* <code>ListKeyGroups</code>.</p>
|