UpdateCachePolicy - Amazon CloudFront

UpdateCachePolicy

Updates a cache policy configuration.

When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:

  1. Use GetCachePolicyConfig to get the current configuration.

  2. Locally modify the fields in the cache policy configuration that you want to update.

  3. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.

Request Syntax

PUT /2020-05-31/cache-policy/Id HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <CachePolicyConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/"> <Comment>string</Comment> <DefaultTTL>long</DefaultTTL> <MaxTTL>long</MaxTTL> <MinTTL>long</MinTTL> <Name>string</Name> <ParametersInCacheKeyAndForwardedToOrigin> <CookiesConfig> <CookieBehavior>string</CookieBehavior> <Cookies> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </Cookies> </CookiesConfig> <EnableAcceptEncodingBrotli>boolean</EnableAcceptEncodingBrotli> <EnableAcceptEncodingGzip>boolean</EnableAcceptEncodingGzip> <HeadersConfig> <HeaderBehavior>string</HeaderBehavior> <Headers> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </Headers> </HeadersConfig> <QueryStringsConfig> <QueryStringBehavior>string</QueryStringBehavior> <QueryStrings> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </QueryStrings> </QueryStringsConfig> </ParametersInCacheKeyAndForwardedToOrigin> </CachePolicyConfig>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

CachePolicyConfig

Root level tag for the CachePolicyConfig parameters.

Required: Yes

Comment

A comment to describe the cache policy.

Type: String

Required: No

DefaultTTL

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Type: Long

Required: No

MaxTTL

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Type: Long

Required: No

MinTTL

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Type: Long

Required: Yes

Name

A unique name to identify the cache policy.

Type: String

Required: Yes

ParametersInCacheKeyAndForwardedToOrigin

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Type: ParametersInCacheKeyAndForwardedToOrigin object

Required: No

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <CachePolicy> <CachePolicyConfig> <Comment>string</Comment> <DefaultTTL>long</DefaultTTL> <MaxTTL>long</MaxTTL> <MinTTL>long</MinTTL> <Name>string</Name> <ParametersInCacheKeyAndForwardedToOrigin> <CookiesConfig> <CookieBehavior>string</CookieBehavior> <Cookies> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </Cookies> </CookiesConfig> <EnableAcceptEncodingBrotli>boolean</EnableAcceptEncodingBrotli> <EnableAcceptEncodingGzip>boolean</EnableAcceptEncodingGzip> <HeadersConfig> <HeaderBehavior>string</HeaderBehavior> <Headers> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </Headers> </HeadersConfig> <QueryStringsConfig> <QueryStringBehavior>string</QueryStringBehavior> <QueryStrings> <Items> <Name>string</Name> </Items> <Quantity>integer</Quantity> </QueryStrings> </QueryStringsConfig> </ParametersInCacheKeyAndForwardedToOrigin> </CachePolicyConfig> <Id>string</Id> <LastModifiedTime>timestamp</LastModifiedTime> </CachePolicy>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

CachePolicy

Root level tag for the CachePolicy parameters.

Required: Yes

CachePolicyConfig

The cache policy configuration.

Type: CachePolicyConfig object

Id

The unique identifier for the cache policy.

Type: String

LastModifiedTime

The date and time when the cache policy was last modified.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDenied

Access denied.

HTTP Status Code: 403

CachePolicyAlreadyExists

A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use UpdateCachePolicy.

HTTP Status Code: 409

IllegalUpdate

The update contains modifications that are not allowed.

HTTP Status Code: 400

InconsistentQuantities

The value of Quantity and the size of Items don't match.

HTTP Status Code: 400

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

InvalidIfMatchVersion

The If-Match version is missing or not valid.

HTTP Status Code: 400

NoSuchCachePolicy

The cache policy does not exist.

HTTP Status Code: 404

PreconditionFailed

The precondition given in one or more of the request header fields evaluated to false.

HTTP Status Code: 412

TooManyCookiesInCachePolicy

The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

HTTP Status Code: 400

TooManyHeadersInCachePolicy

The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

HTTP Status Code: 400

TooManyQueryStringsInCachePolicy

The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: