aws_cloudfront_distribution
account_id
Type: STRING
active_trusted_key_groups
Type: STRUCT
Provider name: ActiveTrustedKeyGroups
Description: This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
key_group_id
Type: STRING
Provider name: KeyGroupId
Description: The identifier of the key group that contains the public keys.
key_pair_ids
Type: STRUCT
Provider name: KeyPairIds
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of CloudFront key pair identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of key pair identifiers in the list.
quantity
Type: INT32
Provider name: Quantity
Description: The number of key groups in the list.
active_trusted_signers
Type: STRUCT
Provider name: ActiveTrustedSigners
Description: We recommend using TrustedKeyGroups instead of TrustedSigners. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
aws_account_number
Type: STRING
Provider name: AwsAccountNumber
Description: An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.
key_pair_ids
Type: STRUCT
Provider name: KeyPairIds
Description: A list of CloudFront key pair identifiers.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of CloudFront key pair identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of key pair identifiers in the list.
quantity
Type: INT32
Provider name: Quantity
Description: The number of Amazon Web Services accounts in the list.
alias_icp_recordals
Type: UNORDERED_LIST_STRUCT
Provider name: AliasICPRecordals
Description: Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they’ve added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
cname
Type: STRING
Provider name: CNAME
Description: A domain name associated with a distribution.
icp_recordal_status
Type: STRING
Provider name: ICPRecordalStatus
Description: 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.
arn
Type: STRING
Provider name: ARN
Description: The distribution’s Amazon Resource Name (ARN).
distribution_config
Type: STRUCT
Provider name: DistributionConfig
Description: The distribution’s configuration.
aliases
Type: STRUCT
Provider name: Aliases
Description: A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
quantity
Type: INT32
Provider name: Quantity
Description: The number of CNAME aliases, if any, that you want to associate with this distribution.
cache_behaviors
Type: STRUCT
Provider name: CacheBehaviors
Description: A complex type that contains zero or more CacheBehavior elements.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.
allowed_methods
Type: STRUCT
Provider name: AllowedMethods
cached_methods
Type: STRUCT
Provider name: CachedMethods
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for CachedMethods include GET, HEAD, and OPTIONS, depending on which caching option you choose. For more information, see the preceding section.
quantity
Type: INT32
Provider name: Quantity
Description: The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
quantity
Type: INT32
Provider name: Quantity
Description: The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).
cache_policy_id
Type: STRING
Provider name: CachePolicyId
Description: The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
compress
Type: BOOLEAN
Provider name: Compress
Description: 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.
default_ttl
Type: INT64
Provider name: DefaultTTL
Description: This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
field_level_encryption_id
Type: STRING
Provider name: FieldLevelEncryptionId
Description: The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
forwarded_values
Type: STRUCT
Provider name: ForwardedValues
Description: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
cookies
Type: STRUCT
Provider name: Cookies
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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
Type: STRING
Provider name: Forward
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type. Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
whitelisted_names
Type: STRUCT
Provider name: WhitelistedNames
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Required if you specify whitelist for the value of Forward. 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 all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don’t delete the WhitelistedNames element 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 Amazon Web Services General Reference.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of cookie names.
quantity
Type: INT32
Provider name: Quantity
Description: The number of cookie names in the Items list.
headers
Type: STRUCT
Provider name: Headers
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of HTTP header names.
quantity
Type: INT32
Provider name: Quantity
Description: The number of header names in the Items list.
query_string
Type: BOOLEAN
Provider name: QueryString
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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 QueryString and on the values that you specify for QueryStringCacheKeys, if any: If you specify true for QueryString and you don’t specify any values for QueryStringCacheKeys, 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 QueryString and you specify one or more values for QueryStringCacheKeys, 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.
query_string_cache_keys
Type: STRUCT
Provider name: QueryStringCacheKeys
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.
quantity
Type: INT32
Provider name: Quantity
Description: The number of whitelisted query string parameters for a cache behavior.
function_associations
Type: STRUCT
Provider name: FunctionAssociations
Description: A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the LIVE stage to associate them with a cache behavior.
event_type
Type: STRING
Provider name: EventType
Description: The event type of the function, either viewer-request or viewer-response. You cannot use origin-facing event types (origin-request and origin-response) with a CloudFront function.
function_arn
Type: STRING
Provider name: FunctionARN
Description: The Amazon Resource Name (ARN) of the function.
quantity
Type: INT32
Provider name: Quantity
Description: The number of CloudFront functions in the list.
lambda_function_associations
Type: STRUCT
Provider name: LambdaFunctionAssociations
Description: A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.
event_type
Type: STRING
Provider name: EventType
Description: Specifies the event type that triggers a Lambda@Edge 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.
include_body
Type: BOOLEAN
Provider name: IncludeBody
Description: A flag that allows a Lambda@Edge 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.
lambda_function_arn
Type: STRING
Provider name: LambdaFunctionARN
Description: The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can’t specify an alias or $LATEST.
quantity
Type: INT32
Provider name: Quantity
Description: The number of Lambda@Edge function associations for this cache behavior.
max_ttl
Type: INT64
Provider name: MaxTTL
Description: This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
min_ttl
Type: INT64
Provider name: MinTTL
Description: This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
origin_request_policy_id
Type: STRING
Provider name: OriginRequestPolicyId
Description: The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
path_pattern
Type: STRING
Provider name: PathPattern
Description: 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. 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.
realtime_log_config_arn
Type: STRING
Provider name: RealtimeLogConfigArn
Description: The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
response_headers_policy_id
Type: STRING
Provider name: ResponseHeadersPolicyId
Description: The identifier for a response headers policy.
smooth_streaming
Type: BOOLEAN
Provider name: SmoothStreaming
Description: 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, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
target_origin_id
Type: STRING
Provider name: TargetOriginId
Description: The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
trusted_key_groups
Type: STRUCT
Provider name: TrustedKeyGroups
Description: A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of key groups identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of key groups in the list.
trusted_signers
Type: STRUCT
Provider name: TrustedSigners
Description: We recommend using TrustedKeyGroups instead of TrustedSigners. A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of Amazon Web Services account identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of Amazon Web Services accounts in the list.
viewer_protocol_policy
Type: STRING
Provider name: ViewerProtocolPolicy
Description: The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. 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. 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.
quantity
Type: INT32
Provider name: Quantity
Description: The number of cache behaviors for this distribution.
caller_reference
Type: STRING
Provider name: CallerReference
Description: A unique value (for example, a date-time stamp) that ensures that the request can’t be replayed. If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution. If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
comment
Type: STRING
Provider name: Comment
Description: A comment to describe the distribution. The comment cannot be longer than 128 characters.
continuous_deployment_policy_id
Type: STRING
Provider name: ContinuousDeploymentPolicyId
Description: The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.
custom_error_responses
Type: STRUCT
Provider name: CustomErrorResponses
Description: 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.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
error_caching_min_ttl
Type: INT64
Provider name: ErrorCachingMinTTL
Description: 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.
error_code
Type: INT32
Provider name: ErrorCode
Description: The HTTP status code for which you want to specify a custom error page and/or a caching duration.
response_code
Type: STRING
Provider name: ResponseCode
Description: 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
400 or 500 as the ResponseCode for all 4xx or 5xx errors. - You might want to return a
200 status 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 for ResponsePagePath.
response_page_path
Type: STRING
Provider name: ResponsePagePath
Description: 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
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /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
TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.
If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. 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.
quantity
Type: INT32
Provider name: Quantity
Description: The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.
default_cache_behavior
Type: STRUCT
Provider name: DefaultCacheBehavior
Description: A complex type that describes the default cache behavior if you don’t specify a CacheBehavior element or if files don’t match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
allowed_methods
Type: STRUCT
Provider name: AllowedMethods
cached_methods
Type: STRUCT
Provider name: CachedMethods
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for CachedMethods include GET, HEAD, and OPTIONS, depending on which caching option you choose. For more information, see the preceding section.
quantity
Type: INT32
Provider name: Quantity
Description: The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
quantity
Type: INT32
Provider name: Quantity
Description: The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).
cache_policy_id
Type: STRING
Provider name: CachePolicyId
Description: The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
compress
Type: BOOLEAN
Provider name: Compress
Description: 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.
default_ttl
Type: INT64
Provider name: DefaultTTL
Description: This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
field_level_encryption_id
Type: STRING
Provider name: FieldLevelEncryptionId
Description: The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
forwarded_values
Type: STRUCT
Provider name: ForwardedValues
Description: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
cookies
Type: STRUCT
Provider name: Cookies
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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
Type: STRING
Provider name: Forward
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type. Amazon S3 doesn’t process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
whitelisted_names
Type: STRUCT
Provider name: WhitelistedNames
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Required if you specify whitelist for the value of Forward. 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 all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don’t delete the WhitelistedNames element 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 Amazon Web Services General Reference.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of cookie names.
quantity
Type: INT32
Provider name: Quantity
Description: The number of cookie names in the Items list.
headers
Type: STRUCT
Provider name: Headers
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of HTTP header names.
quantity
Type: INT32
Provider name: Quantity
Description: The number of header names in the Items list.
query_string
Type: BOOLEAN
Provider name: QueryString
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. 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 QueryString and on the values that you specify for QueryStringCacheKeys, if any: If you specify true for QueryString and you don’t specify any values for QueryStringCacheKeys, 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 QueryString and you specify one or more values for QueryStringCacheKeys, 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.
query_string_cache_keys
Type: STRUCT
Provider name: QueryStringCacheKeys
Description: 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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.
quantity
Type: INT32
Provider name: Quantity
Description: The number of whitelisted query string parameters for a cache behavior.
function_associations
Type: STRUCT
Provider name: FunctionAssociations
Description: A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the LIVE stage to associate them with a cache behavior.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the LIVE stage to associate them with a cache behavior.
event_type
Type: STRING
Provider name: EventType
Description: The event type of the function, either viewer-request or viewer-response. You cannot use origin-facing event types (origin-request and origin-response) with a CloudFront function.
function_arn
Type: STRING
Provider name: FunctionARN
Description: The Amazon Resource Name (ARN) of the function.
quantity
Type: INT32
Provider name: Quantity
Description: The number of CloudFront functions in the list.
lambda_function_associations
Type: STRUCT
Provider name: LambdaFunctionAssociations
Description: A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.
event_type
Type: STRING
Provider name: EventType
Description: Specifies the event type that triggers a Lambda@Edge 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.
include_body
Type: BOOLEAN
Provider name: IncludeBody
Description: A flag that allows a Lambda@Edge 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.
lambda_function_arn
Type: STRING
Provider name: LambdaFunctionARN
Description: The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can’t specify an alias or $LATEST.
quantity
Type: INT32
Provider name: Quantity
Description: The number of Lambda@Edge function associations for this cache behavior.
max_ttl
Type: INT64
Provider name: MaxTTL
Description: This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
min_ttl
Type: INT64
Provider name: MinTTL
Description: This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. 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 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
origin_request_policy_id
Type: STRING
Provider name: OriginRequestPolicyId
Description: The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
realtime_log_config_arn
Type: STRING
Provider name: RealtimeLogConfigArn
Description: The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
response_headers_policy_id
Type: STRING
Provider name: ResponseHeadersPolicyId
Description: The identifier for a response headers policy.
smooth_streaming
Type: BOOLEAN
Provider name: SmoothStreaming
Description: 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, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
target_origin_id
Type: STRING
Provider name: TargetOriginId
Description: The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
trusted_key_groups
Type: STRUCT
Provider name: TrustedKeyGroups
Description: A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of key groups identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of key groups in the list.
trusted_signers
Type: STRUCT
Provider name: TrustedSigners
Description: We recommend using TrustedKeyGroups instead of TrustedSigners. A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list of Amazon Web Services account identifiers.
quantity
Type: INT32
Provider name: Quantity
Description: The number of Amazon Web Services accounts in the list.
viewer_protocol_policy
Type: STRING
Provider name: ViewerProtocolPolicy
Description: The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. 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. 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.
default_root_object
Type: STRING
Provider name: DefaultRootObject
Description: 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 (https://www.example.com) instead of an object in your distribution (https://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 DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. 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.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: From this field, you can enable or disable the selected distribution.
http_version
Type: STRING
Provider name: HttpVersion
Description: (Optional) Specify the HTTP version(s) 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 TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
is_ipv6_enabled
Type: BOOLEAN
Provider name: IsIPV6Enabled
Description: If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and 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 IpAddress parameter to restrict the IP addresses that can access your content, don’t enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you’re using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- 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 Route 53 Amazon Web Services Integration Developer Guide. If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don’t need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
logging
Type: STRUCT
Provider name: Logging
Description: 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.
bucket
Type: STRING
Provider name: Bucket
Description: The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: 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 false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.
include_cookies
Type: BOOLEAN
Provider name: IncludeCookies
Description: Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don’t want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.
prefix
Type: STRING
Provider name: Prefix
Description: An optional string that you want CloudFront to prefix to the access log filenames for 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 empty Prefix element in the Logging element.
origin_groups
Type: STRUCT
Provider name: OriginGroups
Description: A complex type that contains information about origin groups for this distribution.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: The items (origin groups) in a distribution.
failover_criteria
Type: STRUCT
Provider name: FailoverCriteria
Description: A complex type that contains information about the failover criteria for an origin group.
status_codes
Type: STRUCT
Provider name: StatusCodes
Description: The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
items
Type: UNORDERED_LIST_INT32
Provider name: Items
Description: The items (status codes) for an origin group.
quantity
Type: INT32
Provider name: Quantity
Description: The number of status codes.
id
Type: STRING
Provider name: Id
Description: The origin group’s ID.
members
Type: STRUCT
Provider name: Members
Description: A complex type that contains information about the origins in an origin group.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: Items (origins) in an origin group.
origin_id
Type: STRING
Provider name: OriginId
Description: The ID for an origin in an origin group.
quantity
Type: INT32
Provider name: Quantity
Description: The number of origins in an origin group.
quantity
Type: INT32
Provider name: Quantity
Description: The number of origin groups.
origins
Type: STRUCT
Provider name: Origins
Description: A complex type that contains information about origins for this distribution.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: A list of origins.
connection_attempts
Type: INT32
Provider name: ConnectionAttempts
Description: 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.
connection_timeout
Type: INT32
Provider name: ConnectionTimeout
Description: 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.
custom_headers
Type: STRUCT
Provider name: CustomHeaders
Description: A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
items
Type: UNORDERED_LIST_STRUCT
Provider name: Items
Description: Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.
header_name
Type: STRING
Provider name: HeaderName
Description: 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.
header_value
Type: STRING
Provider name: HeaderValue
Description: The value for the header that you specified in the HeaderName field.
quantity
Type: INT32
Provider name: Quantity
Description: The number of custom headers, if any, for this distribution.
custom_origin_config
Type: STRUCT
Provider name: CustomOriginConfig
Description: Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
http_port
Type: INT32
Provider name: HTTPPort
Description: The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
https_port
Type: INT32
Provider name: HTTPSPort
Description: The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
origin_keepalive_timeout
Type: INT32
Provider name: OriginKeepaliveTimeout
Description: 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.
origin_protocol_policy
Type: STRING
Provider name: OriginProtocolPolicy
Description: 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.
origin_read_timeout
Type: INT32
Provider name: OriginReadTimeout
Description: 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.
origin_ssl_protocols
Type: STRUCT
Provider name: OriginSslProtocols
Description: Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A list that contains allowed SSL/TLS protocols for this distribution.
quantity
Type: INT32
Provider name: Quantity
Description: The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
domain_name
Type: STRING
Provider name: DomainName
Description: The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
id
Type: STRING
Provider name: Id
Description: A unique identifier for the origin. This value must be unique within the distribution. Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
origin_access_control_id
Type: STRING
Provider name: OriginAccessControlId
Description: The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
origin_path
Type: STRING
Provider name: OriginPath
Description: 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.
origin_shield
Type: STRUCT
Provider name: OriginShield
Description: CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: A flag that specifies whether Origin Shield is enabled. When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
origin_shield_region
Type: STRING
Provider name: OriginShieldRegion
Description: The Amazon Web Services Region for Origin Shield. Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2. When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide.
s3_origin_config
Type: STRUCT
Provider name: S3OriginConfig
Description: 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 CustomOriginConfig type instead.
origin_access_identity
Type: STRING
Provider name: OriginAccessIdentity
Description: If you’re using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide. 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 The ID-of-origin-access-identity is the value that CloudFront returned in the ID element 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 OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. 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.
quantity
Type: INT32
Provider name: Quantity
Description: The number of origins for this distribution.
price_class
Type: STRING
Provider name: PriceClass
Description: 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.
restrictions
Type: STRUCT
Provider name: Restrictions
Description: A complex type that identifies ways in which you want to restrict distribution of your content.
geo_restriction
Type: STRUCT
Provider name: GeoRestriction
Description: A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
items
Type: UNORDERED_LIST_STRING
Provider name: Items
Description: A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code 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.
quantity
Type: INT32
Provider name: Quantity
Description: When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.
restriction_type
Type: STRING
Provider name: RestrictionType
Description: 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: The Location elements specify the countries in which you don’t want CloudFront to distribute your content.whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
staging
Type: BOOLEAN
Provider name: Staging
Description: A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
viewer_certificate
Type: STRUCT
Provider name: ViewerCertificate
Description: A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
acm_certificate_arn
Type: STRING
Provider name: ACMCertificateArn
Description: If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in 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 MinimumProtocolVersion and SSLSupportMethod.
certificate
Type: STRING
Provider name: Certificate
Description: This field is deprecated. Use one of the following fields instead:ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificate
certificate_source
Type: STRING
Provider name: CertificateSource
Description: This field is deprecated. Use one of the following fields instead:ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificate
cloud_front_default_certificate
Type: BOOLEAN
Provider name: CloudFrontDefaultCertificate
Description: If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true. If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethod
iam_certificate_id
Type: STRING
Provider name: IAMCertificateId
Description: If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
minimum_protocol_version
Type: STRING
Provider name: MinimumProtocolVersion
Description: 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. On the CloudFront console, this setting is called Security Policy. When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher. If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
ssl_support_method
Type: STRING
Provider name: SSLSupportMethod
Description: 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.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.
web_acl_id
Type: STRING
Provider name: WebACLId
Description: A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.
domain_name
Type: STRING
Provider name: DomainName
Description: The distribution’s CloudFront domain name. For example: d111111abcdef8.cloudfront.net.
e_tag
Type: STRING
Provider name: ETag
Description: The current version of the distribution’s information. For example: E2QWRUHAPOMQZL.
id
Type: STRING
Provider name: Id
Description: The distribution’s identifier. For example: E1U5RQF7T870K0.
in_progress_invalidation_batches
Type: INT32
Provider name: InProgressInvalidationBatches
Description: The number of invalidation batches currently in progress.
last_modified_time
Type: TIMESTAMP
Provider name: LastModifiedTime
Description: The date and time when the distribution was last modified.
status
Type: STRING
Provider name: Status
Description: The distribution’s status. When the status is Deployed, the distribution’s information is fully propagated to all CloudFront edge locations.
Type: UNORDERED_LIST_STRING
