[ aws . cloudfront ]
update-distribution¶
Description¶
Updates the configuration for a web distribution.
Warning
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide .
The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide .
To update a web distribution using the CloudFront API
Submit a GetDistributionConfig request to get the current configuration and an
Etagheader for the distribution.
Note
If you update the distribution again, you must get a new Etag header.
Update the XML document that was returned in the response to your
GetDistributionConfigrequest to include your changes.
Warning
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven’t configured for your distribution. This is expected and required to successfully update the distribution.
You can’t change the value of
CallerReference. If you try to change this value, CloudFront returns anIllegalUpdateerror.The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistributionrequest are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example,CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the correspondingQuantityelement.
Submit an
UpdateDistributionrequest to update the configuration for your distribution:In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a
DistributionConfigelement.Set the value of the HTTP
If-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGetDistributionConfigrequest in Step 1.
Review the response to the
UpdateDistributionrequest to confirm that the configuration was successfully updated.Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of
StatusisDeployed.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-distribution
[--distribution-config <value>]
--id <value>
[--if-match <value>]
[--default-root-object <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--distribution-config (structure)
The distribution’s configuration information.
CallerReference -> (string)
A unique value (for example, a date-time stamp) that ensures that the request can’t be replayed.
If the value of
CallerReferenceis new (regardless of the content of theDistributionConfigobject), CloudFront creates a new distribution.If
CallerReferenceis a value that you already sent in a previous request to create a distribution, CloudFront returns aDistributionAlreadyExistserror.Aliases -> (structure)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity -> (integer)
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items -> (list)
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
(string)
DefaultRootObject -> (string)
The object that you want CloudFront to request from your origin (for example,
index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.Specify only the object name, for example,
index.html. Don’t add a/before the object name.If you don’t want to specify a default root object when you create a distribution, include an empty
DefaultRootObjectelement.To delete the default root object from an existing distribution, update the distribution configuration and include an empty
DefaultRootObjectelement.To replace the default root object, update the distribution configuration and specify the new object.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
Origins -> (structure)
A complex type that contains information about origins for this distribution.
Quantity -> (integer)
The number of origins or origin groups for this distribution.
Items -> (list)
A complex type that contains origins or origin groups for this distribution.
(structure)
An origin.
An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
Use the
S3OriginConfigtype to specify an Amazon S3 bucket that is * not * configured with static website hosting.Use the
CustomOriginConfigtype to specify various other kinds of content containers or HTTP servers, including:
An Amazon S3 bucket that is configured with static website hosting
An Elastic Load Balancing load balancer
An AWS Elemental MediaPackage origin
An AWS Elemental MediaStore container
Any other HTTP server, running on an Amazon EC2 instance or any other kind of host
For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).
Id -> (string)
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginIdin aCacheBehaviororDefaultCacheBehavior.DomainName -> (string)
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath -> (string)
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders -> (structure)
A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of custom headers, if any, for this distribution.
Items -> (list)
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.(structure)
A complex type that contains
HeaderNameandHeaderValueelements, if any, for this distribution.HeaderName -> (string)
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue -> (string)
The value for the header that you specified in the
HeaderNamefield.S3OriginConfig -> (structure)
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
CustomOriginConfigtype instead.OriginAccessIdentity -> (string)
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the
IDelement when you created the origin access identity.If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty
OriginAccessIdentityelement.To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty
OriginAccessIdentityelement.To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig -> (structure)
Use this type to specify an origin that is a content container or HTTP server, including an Amazon S3 bucket that is configured with static website hosting. To specify an Amazon S3 bucket that is * not * configured with static website hosting, use the
S3OriginConfigtype instead.HTTPPort -> (integer)
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort -> (integer)
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy -> (string)
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only– CloudFront always uses HTTP to connect to the origin.
match-viewer– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
https-only– CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols -> (structure)
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3,TLSv1,TLSv1.1, andTLSv1.2.For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items -> (list)
A list that contains allowed SSL/TLS protocols for this distribution.
(string)
OriginReadTimeout -> (integer)
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout -> (integer)
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.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts -> (integer)
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.
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 Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout -> (integer)
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.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginGroups -> (structure)
A complex type that contains information about origin groups for this distribution.
Quantity -> (integer)
The number of origin groups.
Items -> (list)
The items (origin groups) in a distribution.
(structure)
An origin group includes two origins (a primary origin and a second 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 specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you’ve chosen.
Id -> (string)
The origin group’s ID.
FailoverCriteria -> (structure)
A complex type that contains information about the failover criteria for an origin group.
StatusCodes -> (structure)
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity -> (integer)
The number of status codes.
Items -> (list)
The items (status codes) for an origin group.
(integer)
Members -> (structure)
A complex type that contains information about the origins in an origin group.
Quantity -> (integer)
The number of origins in an origin group.
Items -> (list)
Items (origins) in an origin group.
(structure)
An origin in an origin group.
OriginId -> (string)
The ID for an origin in an origin group.
DefaultCacheBehavior -> (structure)
A complex type that describes the default cache behavior if you don’t specify a
CacheBehaviorelement or if files don’t match any of the values ofPathPatterninCacheBehaviorelements. You must create exactly one default cache behavior.TargetOriginId -> (string)
The value of
IDfor the origin that you want CloudFront to route requests to when they use the default cache behavior.TrustedSigners -> (structure)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPatternfor this cache behavior, specifytrueforEnabled, and specify the applicable values forQuantityandItems. For more information, see Serving Private Content with Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide .If you don’t want to require signed URLs in requests for objects that match
PathPattern, specifyfalseforEnabledand0forQuantity. OmitItems.To add, change, or remove one or more trusted signers, change
Enabledtotrue(if it’s currentlyfalse), changeQuantityas applicable, and specify all of the trusted signers that you want to include in the updated distribution.Enabled -> (boolean)
Specifies whether you want to require viewers to use signed URLs to access the files specified by
PathPatternandTargetOriginId.Quantity -> (integer)
The number of trusted signers for this cache behavior.
Items -> (list)
Optional : A complex type that contains trusted signers for this cache behavior. If
Quantityis0, you can omitItems.(string)
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: 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.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
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 Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods -> (structure)
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:
CloudFront forwards only
GETandHEADrequests.CloudFront forwards only
GET,HEAD, andOPTIONSrequests.CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.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.
Quantity -> (integer)
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
GETandHEADrequests), 3 (forGET,HEAD, andOPTIONSrequests) and 7 (forGET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
(string)
CachedMethods -> (structure)
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to
GETandHEADrequests.CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.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.
Quantity -> (integer)
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are
2(for caching responses toGETandHEADrequests) and3(for caching responses toGET,HEAD, andOPTIONSrequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
(string)
SmoothStreaming -> (boolean)
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
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.Compress -> (boolean)
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true; if not, specifyfalse. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .LambdaFunctionAssociations -> (structure)
A complex type that contains zero or more Lambda function associations for a cache behavior.
Quantity -> (integer)
The number of Lambda function associations for this cache behavior.
Items -> (list)
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.(structure)
A complex type that contains a Lambda function association.
LambdaFunctionARN -> (string)
The ARN of the Lambda function. You must specify the ARN of a function version; you can’t specify a Lambda alias or $LATEST.
EventType -> (string)
Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: 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.
origin-request: 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.
origin-response: 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.
viewer-response: 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. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn’t execute.IncludeBody -> (boolean)
A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FieldLevelEncryptionId -> (string)
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.CachePolicyId -> (string)
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see CachePolicy .
OriginRequestPolicyId -> (string)
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see OriginRequestPolicy .
ForwardedValues -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a
CachePolicy. SeeCreateCachePolicy.If you want to send values to the origin but not include them in the cache key, use an
OriginRequestPolicy. SeeCreateOriginRequestPolicy.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString -> (boolean)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.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
QueryStringand on the values that you specify forQueryStringCacheKeys, if any:If you specify true for
QueryStringand you don’t specify any values forQueryStringCacheKeys, 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.If you specify true for
QueryStringand you specify one or more values forQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.If you specify false for
QueryString, CloudFront doesn’t forward any query string parameters to the origin, and doesn’t cache based on query string parameters.For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward -> (string)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNamescomplex type.Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the
Forwardelement.WhitelistedNames -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Required if you specify
whitelistfor the value ofForward. 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.If you specify
allornonefor the value ofForward, omitWhitelistedNames. If you change the value ofForwardfromwhitelisttoallornoneand you don’t delete theWhitelistedNameselement and its child elements, CloudFront deletes them automatically.For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference .
Quantity -> (integer)
The number of cookie names in the
Itemslist.Items -> (list)
A list of cookie names.
(string)
Headers -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use
HeadersConfigin a cache policy. SeeCreateCachePolicy.If you want to send headers to the origin but not include them in the cache key, use
HeadersConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that specifies the
Headers, 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.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of header names in the
Itemslist.Items -> (list)
A list of HTTP header names.
(string)
QueryStringCacheKeys -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use an
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity -> (integer)
The number of
whitelistedquery string parameters for a cache behavior.Items -> (list)
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If
Quantityis 0, you can omitItems.(string)
MinTTL -> (long)
This field is deprecated. We recommend that you use the
MinTTLfield inCachePolicyConfiginstead of this field.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 Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName).DefaultTTL -> (long)
This field is deprecated. We recommend that you use the
DefaultTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .MaxTTL -> (long)
This field is deprecated. We recommend that you use the
MaxTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .CacheBehaviors -> (structure)
A complex type that contains zero or more
CacheBehaviorelements.Quantity -> (integer)
The number of cache behaviors for this distribution.
Items -> (list)
Optional: A complex type that contains cache behaviors for this distribution. If
Quantityis0, you can omitItems.(structure)
A complex type that describes how CloudFront processes requests.
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.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide .
If you don’t want to specify any cache behaviors, include only an empty
CacheBehaviorselement. Don’t include an emptyCacheBehaviorelement because this is invalid.To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty
CacheBehaviorselement.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.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide .
PathPattern -> (string)
The pattern (for example,
images/*.jpg) 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.Note
You can optionally include a slash (
/) at the beginning of the path pattern. For example,/images/*.jpg. CloudFront behavior is the same with or without the leading/.The path pattern for the default cache behavior is
*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.For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId -> (string)
The value of
IDfor the origin that you want CloudFront to route requests to when they match this cache behavior.TrustedSigners -> (structure)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPatternfor this cache behavior, specifytrueforEnabled, and specify the applicable values forQuantityandItems. For more information, see Serving Private Content with Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide .If you don’t want to require signed URLs in requests for objects that match
PathPattern, specifyfalseforEnabledand0forQuantity. OmitItems.To add, change, or remove one or more trusted signers, change
Enabledtotrue(if it’s currentlyfalse), changeQuantityas applicable, and specify all of the trusted signers that you want to include in the updated distribution.Enabled -> (boolean)
Specifies whether you want to require viewers to use signed URLs to access the files specified by
PathPatternandTargetOriginId.Quantity -> (integer)
The number of trusted signers for this cache behavior.
Items -> (list)
Optional : A complex type that contains trusted signers for this cache behavior. If
Quantityis0, you can omitItems.(string)
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: 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.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
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 Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods -> (structure)
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:
CloudFront forwards only
GETandHEADrequests.CloudFront forwards only
GET,HEAD, andOPTIONSrequests.CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.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.
Quantity -> (integer)
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
GETandHEADrequests), 3 (forGET,HEAD, andOPTIONSrequests) and 7 (forGET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
(string)
CachedMethods -> (structure)
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to
GETandHEADrequests.CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.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.
Quantity -> (integer)
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are
2(for caching responses toGETandHEADrequests) and3(for caching responses toGET,HEAD, andOPTIONSrequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
(string)
SmoothStreaming -> (boolean)
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
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.Compress -> (boolean)
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 Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations -> (structure)
A complex type that contains zero or more Lambda function associations for a cache behavior.
Quantity -> (integer)
The number of Lambda function associations for this cache behavior.
Items -> (list)
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.(structure)
A complex type that contains a Lambda function association.
LambdaFunctionARN -> (string)
The ARN of the Lambda function. You must specify the ARN of a function version; you can’t specify a Lambda alias or $LATEST.
EventType -> (string)
Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: 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.
origin-request: 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.
origin-response: 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.
viewer-response: 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. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn’t execute.IncludeBody -> (boolean)
A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FieldLevelEncryptionId -> (string)
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.CachePolicyId -> (string)
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see
CreateCachePolicy.OriginRequestPolicyId -> (string)
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see
CreateOriginRequestPolicy.ForwardedValues -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a
CachePolicy. SeeCreateCachePolicy.If you want to send values to the origin but not include them in the cache key, use an
OriginRequestPolicy. SeeCreateOriginRequestPolicy.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString -> (boolean)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.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
QueryStringand on the values that you specify forQueryStringCacheKeys, if any:If you specify true for
QueryStringand you don’t specify any values forQueryStringCacheKeys, 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.If you specify true for
QueryStringand you specify one or more values forQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.If you specify false for
QueryString, CloudFront doesn’t forward any query string parameters to the origin, and doesn’t cache based on query string parameters.For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward -> (string)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNamescomplex type.Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the
Forwardelement.WhitelistedNames -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Required if you specify
whitelistfor the value ofForward. 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.If you specify
allornonefor the value ofForward, omitWhitelistedNames. If you change the value ofForwardfromwhitelisttoallornoneand you don’t delete theWhitelistedNameselement and its child elements, CloudFront deletes them automatically.For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference .
Quantity -> (integer)
The number of cookie names in the
Itemslist.Items -> (list)
A list of cookie names.
(string)
Headers -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use
HeadersConfigin a cache policy. SeeCreateCachePolicy.If you want to send headers to the origin but not include them in the cache key, use
HeadersConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that specifies the
Headers, 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.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of header names in the
Itemslist.Items -> (list)
A list of HTTP header names.
(string)
QueryStringCacheKeys -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use an
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity -> (integer)
The number of
whitelistedquery string parameters for a cache behavior.Items -> (list)
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If
Quantityis 0, you can omitItems.(string)
MinTTL -> (long)
This field is deprecated. We recommend that you use the
MinTTLfield inCachePolicyConfiginstead of this field.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 Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName).DefaultTTL -> (long)
This field is deprecated. We recommend that you use the
DefaultTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .MaxTTL -> (long)
This field is deprecated. We recommend that you use the
MaxTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .CustomErrorResponses -> (structure)
A complex type that controls the following:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If
Quantityis0, you can omitItems.Items -> (list)
A complex type that contains a
CustomErrorResponseelement for each HTTP status code for which you want to specify a custom error page and/or a caching duration.(structure)
A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode -> (integer)
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath -> (string)
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
ErrorCode, for example,/4xx-errors/403-forbidden.html. 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:
The value of
PathPatternmatches 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/4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*.The value of
TargetOriginIdspecifies the value of theIDelement for the origin that contains your custom error pages.If you specify a value for
ResponsePagePath, you must also specify a value forResponseCode.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.
ResponseCode -> (string)
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:
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
200, the response typically won’t be intercepted.If you don’t care about distinguishing among different client errors or server errors, you can specify
400or500as theResponseCodefor all 4xx or 5xx errors.You might want to return a
200status code (OK) and static website so your customers don’t know that your website is down.If you specify a value for
ResponseCode, you must also specify a value forResponsePagePath.ErrorCachingMinTTL -> (long)
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode. 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.For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment -> (string)
Any comments you want to include about the distribution.
If you don’t want to specify a comment, include an empty
Commentelement.To delete an existing comment, update the distribution configuration and include an empty
Commentelement.To add or change a comment, update the distribution configuration and specify the new comment.
Logging -> (structure)
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Enabled -> (boolean)
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
falseforEnabled, and specify emptyBucketandPrefixelements. If you specifyfalseforEnabledbut you specify values forBucket,prefix, andIncludeCookies, the values are automatically deleted.IncludeCookies -> (boolean)
Specifies whether you want CloudFront to include cookies in access logs, specify
trueforIncludeCookies. 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, specifyfalseforIncludeCookies.Bucket -> (string)
The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com.Prefix -> (string)
An optional string that you want CloudFront to prefix to the access log
filenamesfor this distribution, for example,myprefix/. If you want to enable logging, but you don’t want to specify a prefix, you still must include an emptyPrefixelement in theLoggingelement.PriceClass -> (string)
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.If you specify a price class other than
PriceClass_All, 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.For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing . For price class information, scroll down to see the table at the bottom of the page.
Enabled -> (boolean)
From this field, you can enable or disable the selected distribution.
ViewerCertificate -> (structure)
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate -> (boolean)
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net, set this field totrue.If the distribution uses
Aliases(alternate domain names or CNAMEs), set this field tofalseand specify values for the following fields:
ACMCertificateArnorIAMCertificateId(specify a value for one, not both)
MinimumProtocolVersion
SSLSupportMethodIAMCertificateId -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM) , provide the ID of the IAM certificate.If you specify an IAM certificate ID, you must also specify values for
MinimumProtocolVerisonandSSLSupportMethod.ACMCertificateArn -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).If you specify an ACM certificate ARN, you must also specify values for
MinimumProtocolVerisonandSSLSupportMethod.SSLSupportMethod -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.
vip– 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.If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net, don’t set a value for this field.MinimumProtocolVersion -> (string)
If the distribution uses
Aliases(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:
The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set
SSLSupportMethodtosni-only), you must specifyTLSv1or higher.If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net(you setCloudFrontDefaultCertificatetotrue), CloudFront automatically sets the security policy toTLSv1regardless of the value that you set here.Certificate -> (string)
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificateCertificateSource -> (string)
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificateRestrictions -> (structure)
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction -> (structure)
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using
MaxMindGeoIP databases.RestrictionType -> (string)
The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: TheLocationelements specify the countries in which you don’t want CloudFront to distribute your content.
whitelist: TheLocationelements specify the countries in which you want CloudFront to distribute your content.Quantity -> (integer)
When geo restriction is
enabled, this is the number of countries in yourwhitelistorblacklist. Otherwise, when it is not enabled,Quantityis0, and you can omitItems.Items -> (list)
A complex type that contains a
Locationelement for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).The
Locationelement is a two-letter, uppercase country code for a country that you want to include in yourblacklistorwhitelist. Include oneLocationelement for each country.CloudFront and
MaxMindboth useISO 3166country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.(string)
WebACLId -> (string)
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a.AWS 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 AWS WAF, see the AWS WAF Developer Guide .
HttpVersion -> (string)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don’t support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for “http/2 optimization.”
IsIPV6Enabled -> (boolean)
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true. If you specifyfalse, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERRORand with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.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
IpAddressparameter 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 Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .If you’re using an Amazon Route 53 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:
You enable IPv6 for the distribution
You’re using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide .
If you created a CNAME resource record set, either with Amazon Route 53 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.
JSON Syntax:
{
"CallerReference": "string",
"Aliases": {
"Quantity": integer,
"Items": ["string", ...]
},
"DefaultRootObject": "string",
"Origins": {
"Quantity": integer,
"Items": [
{
"Id": "string",
"DomainName": "string",
"OriginPath": "string",
"CustomHeaders": {
"Quantity": integer,
"Items": [
{
"HeaderName": "string",
"HeaderValue": "string"
}
...
]
},
"S3OriginConfig": {
"OriginAccessIdentity": "string"
},
"CustomOriginConfig": {
"HTTPPort": integer,
"HTTPSPort": integer,
"OriginProtocolPolicy": "http-only"|"match-viewer"|"https-only",
"OriginSslProtocols": {
"Quantity": integer,
"Items": ["SSLv3"|"TLSv1"|"TLSv1.1"|"TLSv1.2", ...]
},
"OriginReadTimeout": integer,
"OriginKeepaliveTimeout": integer
},
"ConnectionAttempts": integer,
"ConnectionTimeout": integer
}
...
]
},
"OriginGroups": {
"Quantity": integer,
"Items": [
{
"Id": "string",
"FailoverCriteria": {
"StatusCodes": {
"Quantity": integer,
"Items": [integer, ...]
}
},
"Members": {
"Quantity": integer,
"Items": [
{
"OriginId": "string"
}
...
]
}
}
...
]
},
"DefaultCacheBehavior": {
"TargetOriginId": "string",
"TrustedSigners": {
"Enabled": true|false,
"Quantity": integer,
"Items": ["string", ...]
},
"ViewerProtocolPolicy": "allow-all"|"https-only"|"redirect-to-https",
"AllowedMethods": {
"Quantity": integer,
"Items": ["GET"|"HEAD"|"POST"|"PUT"|"PATCH"|"OPTIONS"|"DELETE", ...],
"CachedMethods": {
"Quantity": integer,
"Items": ["GET"|"HEAD"|"POST"|"PUT"|"PATCH"|"OPTIONS"|"DELETE", ...]
}
},
"SmoothStreaming": true|false,
"Compress": true|false,
"LambdaFunctionAssociations": {
"Quantity": integer,
"Items": [
{
"LambdaFunctionARN": "string",
"EventType": "viewer-request"|"viewer-response"|"origin-request"|"origin-response",
"IncludeBody": true|false
}
...
]
},
"FieldLevelEncryptionId": "string",
"CachePolicyId": "string",
"OriginRequestPolicyId": "string",
"ForwardedValues": {
"QueryString": true|false,
"Cookies": {
"Forward": "none"|"whitelist"|"all",
"WhitelistedNames": {
"Quantity": integer,
"Items": ["string", ...]
}
},
"Headers": {
"Quantity": integer,
"Items": ["string", ...]
},
"QueryStringCacheKeys": {
"Quantity": integer,
"Items": ["string", ...]
}
},
"MinTTL": long,
"DefaultTTL": long,
"MaxTTL": long
},
"CacheBehaviors": {
"Quantity": integer,
"Items": [
{
"PathPattern": "string",
"TargetOriginId": "string",
"TrustedSigners": {
"Enabled": true|false,
"Quantity": integer,
"Items": ["string", ...]
},
"ViewerProtocolPolicy": "allow-all"|"https-only"|"redirect-to-https",
"AllowedMethods": {
"Quantity": integer,
"Items": ["GET"|"HEAD"|"POST"|"PUT"|"PATCH"|"OPTIONS"|"DELETE", ...],
"CachedMethods": {
"Quantity": integer,
"Items": ["GET"|"HEAD"|"POST"|"PUT"|"PATCH"|"OPTIONS"|"DELETE", ...]
}
},
"SmoothStreaming": true|false,
"Compress": true|false,
"LambdaFunctionAssociations": {
"Quantity": integer,
"Items": [
{
"LambdaFunctionARN": "string",
"EventType": "viewer-request"|"viewer-response"|"origin-request"|"origin-response",
"IncludeBody": true|false
}
...
]
},
"FieldLevelEncryptionId": "string",
"CachePolicyId": "string",
"OriginRequestPolicyId": "string",
"ForwardedValues": {
"QueryString": true|false,
"Cookies": {
"Forward": "none"|"whitelist"|"all",
"WhitelistedNames": {
"Quantity": integer,
"Items": ["string", ...]
}
},
"Headers": {
"Quantity": integer,
"Items": ["string", ...]
},
"QueryStringCacheKeys": {
"Quantity": integer,
"Items": ["string", ...]
}
},
"MinTTL": long,
"DefaultTTL": long,
"MaxTTL": long
}
...
]
},
"CustomErrorResponses": {
"Quantity": integer,
"Items": [
{
"ErrorCode": integer,
"ResponsePagePath": "string",
"ResponseCode": "string",
"ErrorCachingMinTTL": long
}
...
]
},
"Comment": "string",
"Logging": {
"Enabled": true|false,
"IncludeCookies": true|false,
"Bucket": "string",
"Prefix": "string"
},
"PriceClass": "PriceClass_100"|"PriceClass_200"|"PriceClass_All",
"Enabled": true|false,
"ViewerCertificate": {
"CloudFrontDefaultCertificate": true|false,
"IAMCertificateId": "string",
"ACMCertificateArn": "string",
"SSLSupportMethod": "sni-only"|"vip",
"MinimumProtocolVersion": "SSLv3"|"TLSv1"|"TLSv1_2016"|"TLSv1.1_2016"|"TLSv1.2_2018"|"TLSv1.2_2019",
"Certificate": "string",
"CertificateSource": "cloudfront"|"iam"|"acm"
},
"Restrictions": {
"GeoRestriction": {
"RestrictionType": "blacklist"|"whitelist"|"none",
"Quantity": integer,
"Items": ["string", ...]
}
},
"WebACLId": "string",
"HttpVersion": "http1.1"|"http2",
"IsIPV6Enabled": true|false
}
--id (string)
The distribution’s id.
--if-match (string)
The value of the
ETagheader that you received when retrieving the distribution’s configuration. For example:E2QWRUHAPOMQZL.
--default-root-object (string)
The object that you want CloudFront to return (for example, index.html) when a viewer request points to your root URL. CLI will automatically make a get-distribution-config call to load and preserve your other settings. This argument and –distribution-config are mututally exclusive.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To update a CloudFront distribution’s default root object
The following example updates the default root object to index.html for the
CloudFront distribution with the ID EDFDVBD6EXAMPLE:
aws cloudfront update-distribution --id EDFDVBD6EXAMPLE \
--default-root-object index.html
Output:
{
"ETag": "E2QWRUHEXAMPLE",
"Distribution": {
"Id": "EDFDVBD6EXAMPLE",
"ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
"Status": "InProgress",
"LastModifiedTime": "2019-12-06T18:55:39.870Z",
"InProgressInvalidationBatches": 0,
"DomainName": "d111111abcdef8.cloudfront.net",
"ActiveTrustedSigners": {
"Enabled": false,
"Quantity": 0
},
"DistributionConfig": {
"CallerReference": "6b10378d-49be-4c4b-a642-419ccaf8f3b5",
"Aliases": {
"Quantity": 0
},
"DefaultRootObject": "index.html",
"Origins": {
"Quantity": 1,
"Items": [
{
"Id": "example-website",
"DomainName": "www.example.com",
"OriginPath": "",
"CustomHeaders": {
"Quantity": 0
},
"CustomOriginConfig": {
"HTTPPort": 80,
"HTTPSPort": 443,
"OriginProtocolPolicy": "match-viewer",
"OriginSslProtocols": {
"Quantity": 2,
"Items": [
"SSLv3",
"TLSv1"
]
},
"OriginReadTimeout": 30,
"OriginKeepaliveTimeout": 5
}
}
]
},
"OriginGroups": {
"Quantity": 0
},
"DefaultCacheBehavior": {
"TargetOriginId": "example-website",
"ForwardedValues": {
"QueryString": false,
"Cookies": {
"Forward": "none"
},
"Headers": {
"Quantity": 1,
"Items": [
"*"
]
},
"QueryStringCacheKeys": {
"Quantity": 0
}
},
"TrustedSigners": {
"Enabled": false,
"Quantity": 0
},
"ViewerProtocolPolicy": "allow-all",
"MinTTL": 0,
"AllowedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
],
"CachedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
]
}
},
"SmoothStreaming": false,
"DefaultTTL": 86400,
"MaxTTL": 31536000,
"Compress": false,
"LambdaFunctionAssociations": {
"Quantity": 0
},
"FieldLevelEncryptionId": ""
},
"CacheBehaviors": {
"Quantity": 0
},
"CustomErrorResponses": {
"Quantity": 0
},
"Comment": "",
"Logging": {
"Enabled": false,
"IncludeCookies": false,
"Bucket": "",
"Prefix": ""
},
"PriceClass": "PriceClass_All",
"Enabled": true,
"ViewerCertificate": {
"CloudFrontDefaultCertificate": true,
"MinimumProtocolVersion": "TLSv1",
"CertificateSource": "cloudfront"
},
"Restrictions": {
"GeoRestriction": {
"RestrictionType": "none",
"Quantity": 0
}
},
"WebACLId": "",
"HttpVersion": "http1.1",
"IsIPV6Enabled": true
}
}
}
To update a CloudFront distribution
The following example disables the CloudFront distribution with the ID
EMLARXS9EXAMPLE by providing the distribution configuration in a JSON file
named dist-config-disable.json. To update a distribution, you must use the
--if-match option to provide the distribution’s ETag. To get the
ETag, use the get-distribution or
get-distribution-config command.
After you use the following example to disable a distribution, you can use the delete-distribution command to delete it.
aws cloudfront update-distribution \
--id EMLARXS9EXAMPLE \
--if-match E2QWRUHEXAMPLE \
--distribution-config file://dist-config-disable.json
The file dist-config-disable.json is a JSON document in the current folder
that contains the following. Note that the Enabled field is set to
false:
{
"CallerReference": "cli-1574382155-496510",
"Aliases": {
"Quantity": 0
},
"DefaultRootObject": "index.html",
"Origins": {
"Quantity": 1,
"Items": [
{
"Id": "awsexamplebucket.s3.amazonaws.com-1574382155-273939",
"DomainName": "awsexamplebucket.s3.amazonaws.com",
"OriginPath": "",
"CustomHeaders": {
"Quantity": 0
},
"S3OriginConfig": {
"OriginAccessIdentity": ""
}
}
]
},
"OriginGroups": {
"Quantity": 0
},
"DefaultCacheBehavior": {
"TargetOriginId": "awsexamplebucket.s3.amazonaws.com-1574382155-273939",
"ForwardedValues": {
"QueryString": false,
"Cookies": {
"Forward": "none"
},
"Headers": {
"Quantity": 0
},
"QueryStringCacheKeys": {
"Quantity": 0
}
},
"TrustedSigners": {
"Enabled": false,
"Quantity": 0
},
"ViewerProtocolPolicy": "allow-all",
"MinTTL": 0,
"AllowedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
],
"CachedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
]
}
},
"SmoothStreaming": false,
"DefaultTTL": 86400,
"MaxTTL": 31536000,
"Compress": false,
"LambdaFunctionAssociations": {
"Quantity": 0
},
"FieldLevelEncryptionId": ""
},
"CacheBehaviors": {
"Quantity": 0
},
"CustomErrorResponses": {
"Quantity": 0
},
"Comment": "",
"Logging": {
"Enabled": false,
"IncludeCookies": false,
"Bucket": "",
"Prefix": ""
},
"PriceClass": "PriceClass_All",
"Enabled": false,
"ViewerCertificate": {
"CloudFrontDefaultCertificate": true,
"MinimumProtocolVersion": "TLSv1",
"CertificateSource": "cloudfront"
},
"Restrictions": {
"GeoRestriction": {
"RestrictionType": "none",
"Quantity": 0
}
},
"WebACLId": "",
"HttpVersion": "http2",
"IsIPV6Enabled": true
}
Output:
{
"ETag": "E9LHASXEXAMPLE",
"Distribution": {
"Id": "EMLARXS9EXAMPLE",
"ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE",
"Status": "InProgress",
"LastModifiedTime": "2019-12-06T18:32:35.553Z",
"InProgressInvalidationBatches": 0,
"DomainName": "d111111abcdef8.cloudfront.net",
"ActiveTrustedSigners": {
"Enabled": false,
"Quantity": 0
},
"DistributionConfig": {
"CallerReference": "cli-1574382155-496510",
"Aliases": {
"Quantity": 0
},
"DefaultRootObject": "index.html",
"Origins": {
"Quantity": 1,
"Items": [
{
"Id": "awsexamplebucket.s3.amazonaws.com-1574382155-273939",
"DomainName": "awsexamplebucket.s3.amazonaws.com",
"OriginPath": "",
"CustomHeaders": {
"Quantity": 0
},
"S3OriginConfig": {
"OriginAccessIdentity": ""
}
}
]
},
"OriginGroups": {
"Quantity": 0
},
"DefaultCacheBehavior": {
"TargetOriginId": "awsexamplebucket.s3.amazonaws.com-1574382155-273939",
"ForwardedValues": {
"QueryString": false,
"Cookies": {
"Forward": "none"
},
"Headers": {
"Quantity": 0
},
"QueryStringCacheKeys": {
"Quantity": 0
}
},
"TrustedSigners": {
"Enabled": false,
"Quantity": 0
},
"ViewerProtocolPolicy": "allow-all",
"MinTTL": 0,
"AllowedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
],
"CachedMethods": {
"Quantity": 2,
"Items": [
"HEAD",
"GET"
]
}
},
"SmoothStreaming": false,
"DefaultTTL": 86400,
"MaxTTL": 31536000,
"Compress": false,
"LambdaFunctionAssociations": {
"Quantity": 0
},
"FieldLevelEncryptionId": ""
},
"CacheBehaviors": {
"Quantity": 0
},
"CustomErrorResponses": {
"Quantity": 0
},
"Comment": "",
"Logging": {
"Enabled": false,
"IncludeCookies": false,
"Bucket": "",
"Prefix": ""
},
"PriceClass": "PriceClass_All",
"Enabled": false,
"ViewerCertificate": {
"CloudFrontDefaultCertificate": true,
"MinimumProtocolVersion": "TLSv1",
"CertificateSource": "cloudfront"
},
"Restrictions": {
"GeoRestriction": {
"RestrictionType": "none",
"Quantity": 0
}
},
"WebACLId": "",
"HttpVersion": "http2",
"IsIPV6Enabled": true
}
}
}
Output¶
Distribution -> (structure)
The distribution’s information.
Id -> (string)
The identifier for the distribution. For example:
EDFDVBD632BHDS5.ARN -> (string)
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where123456789012is your AWS account ID.Status -> (string)
This response element indicates the current status of the distribution. When the status is
Deployed, the distribution’s information is fully propagated to all CloudFront edge locations.LastModifiedTime -> (timestamp)
The date and time the distribution was last modified.
InProgressInvalidationBatches -> (integer)
The number of invalidation batches currently in progress.
DomainName -> (string)
The domain name corresponding to the distribution, for example,
d111111abcdef8.cloudfront.net.ActiveTrustedSigners -> (structure)
CloudFront automatically adds this element to the response only if you’ve set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The
Signerchild element lists the AWS account number of the trusted signer (or an emptySelfelement if the signer is you). TheSignerelement also includes the IDs of any active key pairs associated with the trusted signer’s AWS account. If noKeyPairIdelement appears for aSigner, that signer can’t create working signed URLs.Enabled -> (boolean)
Enabled is
trueif any of the AWS accounts listed in theTrustedSignerscomplex type for this distribution have active CloudFront key pairs. If not,Enabledisfalse.Quantity -> (integer)
The number of trusted signers specified in the
TrustedSignerscomplex type.Items -> (list)
A complex type that contains one
Signercomplex type for each trusted signer that is specified in theTrustedSignerscomplex type.(structure)
A complex type that lists the AWS accounts that were included in the
TrustedSignerscomplex type, as well as their active CloudFront key pair IDs, if any.AwsAccountNumber -> (string)
An AWS account that is included in the
TrustedSignerscomplex type for this distribution. Valid values include:
self, which is the AWS account used to create the distribution.An AWS account number.
KeyPairIds -> (structure)
A complex type that lists the active CloudFront key pairs, if any, that are associated with
AwsAccountNumber.Quantity -> (integer)
The number of active CloudFront key pairs for
AwsAccountNumber.For more information, see ActiveTrustedSigners .
Items -> (list)
A complex type that lists the active CloudFront key pairs, if any, that are associated with
AwsAccountNumber.For more information, see ActiveTrustedSigners .
(string)
DistributionConfig -> (structure)
The current configuration information for the distribution. Send a
GETrequest to the/*CloudFront API version* /distribution ID/configresource.CallerReference -> (string)
A unique value (for example, a date-time stamp) that ensures that the request can’t be replayed.
If the value of
CallerReferenceis new (regardless of the content of theDistributionConfigobject), CloudFront creates a new distribution.If
CallerReferenceis a value that you already sent in a previous request to create a distribution, CloudFront returns aDistributionAlreadyExistserror.Aliases -> (structure)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity -> (integer)
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items -> (list)
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
(string)
DefaultRootObject -> (string)
The object that you want CloudFront to request from your origin (for example,
index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.Specify only the object name, for example,
index.html. Don’t add a/before the object name.If you don’t want to specify a default root object when you create a distribution, include an empty
DefaultRootObjectelement.To delete the default root object from an existing distribution, update the distribution configuration and include an empty
DefaultRootObjectelement.To replace the default root object, update the distribution configuration and specify the new object.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
Origins -> (structure)
A complex type that contains information about origins for this distribution.
Quantity -> (integer)
The number of origins or origin groups for this distribution.
Items -> (list)
A complex type that contains origins or origin groups for this distribution.
(structure)
An origin.
An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
Use the
S3OriginConfigtype to specify an Amazon S3 bucket that is * not * configured with static website hosting.Use the
CustomOriginConfigtype to specify various other kinds of content containers or HTTP servers, including:
An Amazon S3 bucket that is configured with static website hosting
An Elastic Load Balancing load balancer
An AWS Elemental MediaPackage origin
An AWS Elemental MediaStore container
Any other HTTP server, running on an Amazon EC2 instance or any other kind of host
For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).
Id -> (string)
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginIdin aCacheBehaviororDefaultCacheBehavior.DomainName -> (string)
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath -> (string)
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders -> (structure)
A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of custom headers, if any, for this distribution.
Items -> (list)
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.(structure)
A complex type that contains
HeaderNameandHeaderValueelements, if any, for this distribution.HeaderName -> (string)
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue -> (string)
The value for the header that you specified in the
HeaderNamefield.S3OriginConfig -> (structure)
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
CustomOriginConfigtype instead.OriginAccessIdentity -> (string)
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the
IDelement when you created the origin access identity.If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty
OriginAccessIdentityelement.To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty
OriginAccessIdentityelement.To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig -> (structure)
Use this type to specify an origin that is a content container or HTTP server, including an Amazon S3 bucket that is configured with static website hosting. To specify an Amazon S3 bucket that is * not * configured with static website hosting, use the
S3OriginConfigtype instead.HTTPPort -> (integer)
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort -> (integer)
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy -> (string)
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only– CloudFront always uses HTTP to connect to the origin.
match-viewer– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
https-only– CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols -> (structure)
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3,TLSv1,TLSv1.1, andTLSv1.2.For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items -> (list)
A list that contains allowed SSL/TLS protocols for this distribution.
(string)
OriginReadTimeout -> (integer)
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout -> (integer)
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.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts -> (integer)
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.
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 Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout -> (integer)
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.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginGroups -> (structure)
A complex type that contains information about origin groups for this distribution.
Quantity -> (integer)
The number of origin groups.
Items -> (list)
The items (origin groups) in a distribution.
(structure)
An origin group includes two origins (a primary origin and a second 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 specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you’ve chosen.
Id -> (string)
The origin group’s ID.
FailoverCriteria -> (structure)
A complex type that contains information about the failover criteria for an origin group.
StatusCodes -> (structure)
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity -> (integer)
The number of status codes.
Items -> (list)
The items (status codes) for an origin group.
(integer)
Members -> (structure)
A complex type that contains information about the origins in an origin group.
Quantity -> (integer)
The number of origins in an origin group.
Items -> (list)
Items (origins) in an origin group.
(structure)
An origin in an origin group.
OriginId -> (string)
The ID for an origin in an origin group.
DefaultCacheBehavior -> (structure)
A complex type that describes the default cache behavior if you don’t specify a
CacheBehaviorelement or if files don’t match any of the values ofPathPatterninCacheBehaviorelements. You must create exactly one default cache behavior.TargetOriginId -> (string)
The value of
IDfor the origin that you want CloudFront to route requests to when they use the default cache behavior.TrustedSigners -> (structure)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPatternfor this cache behavior, specifytrueforEnabled, and specify the applicable values forQuantityandItems. For more information, see Serving Private Content with Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide .If you don’t want to require signed URLs in requests for objects that match
PathPattern, specifyfalseforEnabledand0forQuantity. OmitItems.To add, change, or remove one or more trusted signers, change
Enabledtotrue(if it’s currentlyfalse), changeQuantityas applicable, and specify all of the trusted signers that you want to include in the updated distribution.Enabled -> (boolean)
Specifies whether you want to require viewers to use signed URLs to access the files specified by
PathPatternandTargetOriginId.Quantity -> (integer)
The number of trusted signers for this cache behavior.
Items -> (list)
Optional : A complex type that contains trusted signers for this cache behavior. If
Quantityis0, you can omitItems.(string)
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: 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.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
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 Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods -> (structure)
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:
CloudFront forwards only
GETandHEADrequests.CloudFront forwards only
GET,HEAD, andOPTIONSrequests.CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.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.
Quantity -> (integer)
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
GETandHEADrequests), 3 (forGET,HEAD, andOPTIONSrequests) and 7 (forGET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
(string)
CachedMethods -> (structure)
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to
GETandHEADrequests.CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.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.
Quantity -> (integer)
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are
2(for caching responses toGETandHEADrequests) and3(for caching responses toGET,HEAD, andOPTIONSrequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
(string)
SmoothStreaming -> (boolean)
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
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.Compress -> (boolean)
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true; if not, specifyfalse. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .LambdaFunctionAssociations -> (structure)
A complex type that contains zero or more Lambda function associations for a cache behavior.
Quantity -> (integer)
The number of Lambda function associations for this cache behavior.
Items -> (list)
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.(structure)
A complex type that contains a Lambda function association.
LambdaFunctionARN -> (string)
The ARN of the Lambda function. You must specify the ARN of a function version; you can’t specify a Lambda alias or $LATEST.
EventType -> (string)
Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: 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.
origin-request: 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.
origin-response: 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.
viewer-response: 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. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn’t execute.IncludeBody -> (boolean)
A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FieldLevelEncryptionId -> (string)
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.CachePolicyId -> (string)
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see CachePolicy .
OriginRequestPolicyId -> (string)
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see OriginRequestPolicy .
ForwardedValues -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a
CachePolicy. SeeCreateCachePolicy.If you want to send values to the origin but not include them in the cache key, use an
OriginRequestPolicy. SeeCreateOriginRequestPolicy.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString -> (boolean)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.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
QueryStringand on the values that you specify forQueryStringCacheKeys, if any:If you specify true for
QueryStringand you don’t specify any values forQueryStringCacheKeys, 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.If you specify true for
QueryStringand you specify one or more values forQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.If you specify false for
QueryString, CloudFront doesn’t forward any query string parameters to the origin, and doesn’t cache based on query string parameters.For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward -> (string)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNamescomplex type.Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the
Forwardelement.WhitelistedNames -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Required if you specify
whitelistfor the value ofForward. 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.If you specify
allornonefor the value ofForward, omitWhitelistedNames. If you change the value ofForwardfromwhitelisttoallornoneand you don’t delete theWhitelistedNameselement and its child elements, CloudFront deletes them automatically.For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference .
Quantity -> (integer)
The number of cookie names in the
Itemslist.Items -> (list)
A list of cookie names.
(string)
Headers -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use
HeadersConfigin a cache policy. SeeCreateCachePolicy.If you want to send headers to the origin but not include them in the cache key, use
HeadersConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that specifies the
Headers, 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.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of header names in the
Itemslist.Items -> (list)
A list of HTTP header names.
(string)
QueryStringCacheKeys -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use an
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity -> (integer)
The number of
whitelistedquery string parameters for a cache behavior.Items -> (list)
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If
Quantityis 0, you can omitItems.(string)
MinTTL -> (long)
This field is deprecated. We recommend that you use the
MinTTLfield inCachePolicyConfiginstead of this field.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 Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName).DefaultTTL -> (long)
This field is deprecated. We recommend that you use the
DefaultTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .MaxTTL -> (long)
This field is deprecated. We recommend that you use the
MaxTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .CacheBehaviors -> (structure)
A complex type that contains zero or more
CacheBehaviorelements.Quantity -> (integer)
The number of cache behaviors for this distribution.
Items -> (list)
Optional: A complex type that contains cache behaviors for this distribution. If
Quantityis0, you can omitItems.(structure)
A complex type that describes how CloudFront processes requests.
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.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide .
If you don’t want to specify any cache behaviors, include only an empty
CacheBehaviorselement. Don’t include an emptyCacheBehaviorelement because this is invalid.To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty
CacheBehaviorselement.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.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide .
PathPattern -> (string)
The pattern (for example,
images/*.jpg) 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.Note
You can optionally include a slash (
/) at the beginning of the path pattern. For example,/images/*.jpg. CloudFront behavior is the same with or without the leading/.The path pattern for the default cache behavior is
*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.For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId -> (string)
The value of
IDfor the origin that you want CloudFront to route requests to when they match this cache behavior.TrustedSigners -> (structure)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPatternfor this cache behavior, specifytrueforEnabled, and specify the applicable values forQuantityandItems. For more information, see Serving Private Content with Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide .If you don’t want to require signed URLs in requests for objects that match
PathPattern, specifyfalseforEnabledand0forQuantity. OmitItems.To add, change, or remove one or more trusted signers, change
Enabledtotrue(if it’s currentlyfalse), changeQuantityas applicable, and specify all of the trusted signers that you want to include in the updated distribution.Enabled -> (boolean)
Specifies whether you want to require viewers to use signed URLs to access the files specified by
PathPatternandTargetOriginId.Quantity -> (integer)
The number of trusted signers for this cache behavior.
Items -> (list)
Optional : A complex type that contains trusted signers for this cache behavior. If
Quantityis0, you can omitItems.(string)
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: 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.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
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 Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods -> (structure)
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:
CloudFront forwards only
GETandHEADrequests.CloudFront forwards only
GET,HEAD, andOPTIONSrequests.CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.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.
Quantity -> (integer)
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
GETandHEADrequests), 3 (forGET,HEAD, andOPTIONSrequests) and 7 (forGET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
(string)
CachedMethods -> (structure)
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to
GETandHEADrequests.CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.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.
Quantity -> (integer)
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are
2(for caching responses toGETandHEADrequests) and3(for caching responses toGET,HEAD, andOPTIONSrequests).Items -> (list)
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
(string)
SmoothStreaming -> (boolean)
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
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.Compress -> (boolean)
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 Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations -> (structure)
A complex type that contains zero or more Lambda function associations for a cache behavior.
Quantity -> (integer)
The number of Lambda function associations for this cache behavior.
Items -> (list)
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.(structure)
A complex type that contains a Lambda function association.
LambdaFunctionARN -> (string)
The ARN of the Lambda function. You must specify the ARN of a function version; you can’t specify a Lambda alias or $LATEST.
EventType -> (string)
Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: 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.
origin-request: 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.
origin-response: 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.
viewer-response: 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. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn’t execute.IncludeBody -> (boolean)
A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FieldLevelEncryptionId -> (string)
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.CachePolicyId -> (string)
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see
CreateCachePolicy.OriginRequestPolicyId -> (string)
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see
CreateOriginRequestPolicy.ForwardedValues -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a
CachePolicy. SeeCreateCachePolicy.If you want to send values to the origin but not include them in the cache key, use an
OriginRequestPolicy. SeeCreateOriginRequestPolicy.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString -> (boolean)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.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
QueryStringand on the values that you specify forQueryStringCacheKeys, if any:If you specify true for
QueryStringand you don’t specify any values forQueryStringCacheKeys, 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.If you specify true for
QueryStringand you specify one or more values forQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.If you specify false for
QueryString, CloudFront doesn’t forward any query string parameters to the origin, and doesn’t cache based on query string parameters.For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward -> (string)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNamescomplex type.Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the
Forwardelement.WhitelistedNames -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use
CookiesConfigin a cache policy. SeeCreateCachePolicy.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfigin an origin request policy. SeeCreateOriginRequestPolicy.Required if you specify
whitelistfor the value ofForward. 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.If you specify
allornonefor the value ofForward, omitWhitelistedNames. If you change the value ofForwardfromwhitelisttoallornoneand you don’t delete theWhitelistedNameselement and its child elements, CloudFront deletes them automatically.For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference .
Quantity -> (integer)
The number of cookie names in the
Itemslist.Items -> (list)
A list of cookie names.
(string)
Headers -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use
HeadersConfigin a cache policy. SeeCreateCachePolicy.If you want to send headers to the origin but not include them in the cache key, use
HeadersConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that specifies the
Headers, 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.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of header names in the
Itemslist.Items -> (list)
A list of HTTP header names.
(string)
QueryStringCacheKeys -> (structure)
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use
QueryStringsConfigin a cache policy. SeeCreateCachePolicy.If you want to send query strings to the origin but not include them in the cache key, use an
QueryStringsConfigin an origin request policy. SeeCreateOriginRequestPolicy.A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity -> (integer)
The number of
whitelistedquery string parameters for a cache behavior.Items -> (list)
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If
Quantityis 0, you can omitItems.(string)
MinTTL -> (long)
This field is deprecated. We recommend that you use the
MinTTLfield inCachePolicyConfiginstead of this field.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 Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName).DefaultTTL -> (long)
This field is deprecated. We recommend that you use the
DefaultTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .MaxTTL -> (long)
This field is deprecated. We recommend that you use the
MaxTTLfield inCachePolicyConfiginstead of this field.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
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .CustomErrorResponses -> (structure)
A complex type that controls the following:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Quantity -> (integer)
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If
Quantityis0, you can omitItems.Items -> (list)
A complex type that contains a
CustomErrorResponseelement for each HTTP status code for which you want to specify a custom error page and/or a caching duration.(structure)
A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode -> (integer)
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath -> (string)
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
ErrorCode, for example,/4xx-errors/403-forbidden.html. 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:
The value of
PathPatternmatches 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/4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*.The value of
TargetOriginIdspecifies the value of theIDelement for the origin that contains your custom error pages.If you specify a value for
ResponsePagePath, you must also specify a value forResponseCode.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.
ResponseCode -> (string)
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:
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
200, the response typically won’t be intercepted.If you don’t care about distinguishing among different client errors or server errors, you can specify
400or500as theResponseCodefor all 4xx or 5xx errors.You might want to return a
200status code (OK) and static website so your customers don’t know that your website is down.If you specify a value for
ResponseCode, you must also specify a value forResponsePagePath.ErrorCachingMinTTL -> (long)
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode. 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.For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment -> (string)
Any comments you want to include about the distribution.
If you don’t want to specify a comment, include an empty
Commentelement.To delete an existing comment, update the distribution configuration and include an empty
Commentelement.To add or change a comment, update the distribution configuration and specify the new comment.
Logging -> (structure)
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Enabled -> (boolean)
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
falseforEnabled, and specify emptyBucketandPrefixelements. If you specifyfalseforEnabledbut you specify values forBucket,prefix, andIncludeCookies, the values are automatically deleted.IncludeCookies -> (boolean)
Specifies whether you want CloudFront to include cookies in access logs, specify
trueforIncludeCookies. 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, specifyfalseforIncludeCookies.Bucket -> (string)
The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com.Prefix -> (string)
An optional string that you want CloudFront to prefix to the access log
filenamesfor this distribution, for example,myprefix/. If you want to enable logging, but you don’t want to specify a prefix, you still must include an emptyPrefixelement in theLoggingelement.PriceClass -> (string)
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.If you specify a price class other than
PriceClass_All, 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.For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing . For price class information, scroll down to see the table at the bottom of the page.
Enabled -> (boolean)
From this field, you can enable or disable the selected distribution.
ViewerCertificate -> (structure)
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate -> (boolean)
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net, set this field totrue.If the distribution uses
Aliases(alternate domain names or CNAMEs), set this field tofalseand specify values for the following fields:
ACMCertificateArnorIAMCertificateId(specify a value for one, not both)
MinimumProtocolVersion
SSLSupportMethodIAMCertificateId -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM) , provide the ID of the IAM certificate.If you specify an IAM certificate ID, you must also specify values for
MinimumProtocolVerisonandSSLSupportMethod.ACMCertificateArn -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).If you specify an ACM certificate ARN, you must also specify values for
MinimumProtocolVerisonandSSLSupportMethod.SSLSupportMethod -> (string)
If the distribution uses
Aliases(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.
vip– 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.If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net, don’t set a value for this field.MinimumProtocolVersion -> (string)
If the distribution uses
Aliases(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:
The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set
SSLSupportMethodtosni-only), you must specifyTLSv1or higher.If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net(you setCloudFrontDefaultCertificatetotrue), CloudFront automatically sets the security policy toTLSv1regardless of the value that you set here.Certificate -> (string)
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificateCertificateSource -> (string)
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificateRestrictions -> (structure)
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction -> (structure)
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using
MaxMindGeoIP databases.RestrictionType -> (string)
The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: TheLocationelements specify the countries in which you don’t want CloudFront to distribute your content.
whitelist: TheLocationelements specify the countries in which you want CloudFront to distribute your content.Quantity -> (integer)
When geo restriction is
enabled, this is the number of countries in yourwhitelistorblacklist. Otherwise, when it is not enabled,Quantityis0, and you can omitItems.Items -> (list)
A complex type that contains a
Locationelement for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).The
Locationelement is a two-letter, uppercase country code for a country that you want to include in yourblacklistorwhitelist. Include oneLocationelement for each country.CloudFront and
MaxMindboth useISO 3166country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.(string)
WebACLId -> (string)
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a.AWS 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 AWS WAF, see the AWS WAF Developer Guide .
HttpVersion -> (string)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don’t support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for “http/2 optimization.”
IsIPV6Enabled -> (boolean)
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true. If you specifyfalse, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERRORand with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.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
IpAddressparameter 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 Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .If you’re using an Amazon Route 53 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:
You enable IPv6 for the distribution
You’re using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide .
If you created a CNAME resource record set, either with Amazon Route 53 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.
AliasICPRecordals -> (list)
AWS 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China .
(structure)
AWS 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China .
CNAME -> (string)
A domain name associated with a distribution.
ICPRecordalStatus -> (string)
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
APPROVED 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 China region, a CNAME must have one ICP recordal number associated with it.
SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
PENDING 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.
ETag -> (string)
The current version of the configuration. For example:
E2QWRUHAPOMQZL.