Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Active
Trusted KeyGroups A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Active
Trusted Signers A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Alias
IcpRecordal Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
- Aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Allowed
Methods 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
GET
andHEAD
requests. -
CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
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.
-
- Anycast
IpList An Anycast static IP list. For more information, see Request Anycast static IPs to use for allowlisting in the Amazon CloudFront Developer Guide.
- Anycast
IpList Collection The Anycast static IP list collection.
- Anycast
IpList Summary An abbreviated version of the
AnycastIpList
structure. Omits the allocated static IP addresses (AnycastIpList$AnycastIps
).- Cache
Behavior 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
CacheBehaviors
element. Don't specify an empty individualCacheBehavior
element, because this is invalid. For more information, see CacheBehaviors.To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty
CacheBehaviors
element.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.
- Cache
Behaviors A complex type that contains zero or more
CacheBehavior
elements.- Cache
Policy A cache policy.
When it's attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use
OriginRequestPolicy
.-
- Cache
Policy Config A cache policy configuration.
This configuration determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use
OriginRequestPolicy
.-
- Cache
Policy Cookies Config An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
- Cache
Policy Headers Config An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
- Cache
Policy List A list of cache policies.
- Cache
Policy Query Strings Config An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
- Cache
Policy Summary Contains a cache policy.
- Cached
Methods 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
GET
andHEAD
requests. -
CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
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.
-
- Certificate
The Certificate Manager (ACM) certificate associated with your distribution.
- Cloud
Front Origin Access Identity CloudFront origin access identity.
- Cloud
Front Origin Access Identity Config Origin access identity configuration. Send a
GET
request to the/CloudFront API version/CloudFront/identity ID/config
resource.- Cloud
Front Origin Access Identity List Lists the origin access identities for CloudFront.Send a
GET
request to the/CloudFront API version/origin-access-identity/cloudfront
resource. The response includes aCloudFrontOriginAccessIdentityList
element with zero or moreCloudFrontOriginAccessIdentitySummary
child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using theMaxItems
andMarker
parameters.- Cloud
Front Origin Access Identity Summary Summary of the information about a CloudFront origin access identity.
- Conflicting
Alias An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it's associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
- Conflicting
Aliases List A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
- Connection
Group The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
- Connection
Group Association Filter Contains information about what CloudFront resources your connection groups are associated with.
- Connection
Group Summary A summary that contains details about your connection groups.
- Content
Type Profile A field-level encryption content type profile.
- Content
Type Profile Config The configuration for a field-level encryption content type-profile mapping.
- Content
Type Profiles Field-level encryption content type-profile.
- Continuous
Deployment Policy A continuous deployment policy.
- Continuous
Deployment Policy Config Contains the configuration for a continuous deployment policy.
- Continuous
Deployment Policy List Contains a list of continuous deployment policies.
- Continuous
Deployment Policy Summary A summary of the information about your continuous deployment policies.
- Continuous
Deployment Single Header Config This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
- Continuous
Deployment Single Weight Config Contains the percentage of traffic to send to a staging distribution.
- Cookie
Names Contains a list of cookie names.
- Cookie
Preference 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
CookiesConfig
in a cache policy. SeeCachePolicy
.If you want to send cookies to the origin but not include them in the cache key, use
CookiesConfig
in an origin request policy. SeeOriginRequestPolicy
.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 Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.
- Custom
Error Response 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.
-
- Custom
Error Responses 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.
-
- Custom
Headers A complex type that contains the list of Custom Headers for each origin.
- Custom
Origin Config A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.
- Customizations
Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
- Default
Cache Behavior A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.- Distribution
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
- Distribution
Config A distribution configuration.
- Distribution
Config With Tags A distribution Configuration and a list of tags to be associated with the distribution.
- Distribution
IdList A list of distribution IDs.
- Distribution
List A distribution list.
- Distribution
Resource Id The IDs for the distribution resources.
- Distribution
Summary A summary of the information about a CloudFront distribution.
- Distribution
Tenant The distribution tenant.
- Distribution
Tenant Association Filter Filter by the associated distribution ID or connection group ID.
- Distribution
Tenant Summary A summary of the information about a distribution tenant.
- DnsConfiguration
The DNS configuration for your domain names.
- Domain
Conflict Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account.
- Domain
Item The domain for the specified distribution tenant.
- Domain
Result The details about the domain result.
- Encryption
Entities Complex data type for field-level encryption profiles that includes all of the encryption entities.
- Encryption
Entity Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
- EndPoint
Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration.
- Field
Level Encryption A complex data type that includes the profile configurations and other options specified for field-level encryption.
- Field
Level Encryption Config A complex data type that includes the profile configurations specified for field-level encryption.
- Field
Level Encryption List List of field-level encryption configurations.
- Field
Level Encryption Profile A complex data type for field-level encryption profiles.
- Field
Level Encryption Profile Config A complex data type of profiles for the field-level encryption.
- Field
Level Encryption Profile List List of field-level encryption profiles.
- Field
Level Encryption Profile Summary The field-level encryption profile summary.
- Field
Level Encryption Summary A summary of a field-level encryption item.
- Field
Patterns A complex data type that includes the field patterns to match for field-level encryption.
- Forwarded
Values 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 cache policy. For more information, see Creating 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 in the Amazon CloudFront Developer Guide.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- Function
Association A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
- Function
Associations A list of 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.- Function
Config Contains configuration information about a CloudFront function.
- Function
List A list of CloudFront functions.
- Function
Metadata Contains metadata about a CloudFront function.
- Function
Summary Contains configuration information and metadata about a CloudFront function.
- GeoRestriction
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using
MaxMind
GeoIP databases.- GeoRestriction
Customization The customizations that you specified for the distribution tenant for geographic restrictions.
- Grpc
Config Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications.
To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported
HTTP
versions and allowHTTP
methods, includingPOST
.For more information, see Using gRPC with CloudFront distributions in the Amazon CloudFront Developer Guide.
- Headers
Contains a list of HTTP header names.
- Import
Source The import source for the key value store.
- Invalidation
An invalidation.
- Invalidation
Batch An invalidation batch.
- Invalidation
List The
InvalidationList
complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.- Invalidation
Summary A summary of an invalidation request.
- KeyGroup
A key group.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
- KeyGroup
Config A key group configuration.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
- KeyGroup
List A list of key groups.
- KeyGroup
Summary Contains information about a key group.
- KeyPair
Ids A list of CloudFront key pair identifiers.
- KeyValue
Store The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.
- KeyValue
Store Association The key value store association.
- KeyValue
Store Associations The key value store associations.
- KeyValue
Store List The key value store list.
- KgKey
Pair Ids A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Kinesis
Stream Config Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
- Lambda
Function Association A complex type that contains a Lambda@Edge function association.
- Lambda
Function Associations A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior.
If you want to invoke one or more Lambda@Edge functions triggered by requests that match the
PathPattern
of the cache behavior, specify the applicable values forQuantity
andItems
. Note that there can be up to 4LambdaFunctionAssociation
items in this list (one for each possible value ofEventType
) and eachEventType
can be associated with only one function.If you don't want to invoke any Lambda@Edge functions for the requests that match
PathPattern
, specify0
forQuantity
and omitItems
.- Logging
Config A complex type that specifies whether access logs are written for the distribution.
If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a different Amazon S3 bucket or use a separate path in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see Standard logging (access logs) in the Amazon CloudFront Developer Guide.
- Managed
Certificate Details Contains details about the CloudFront managed ACM certificate.
- Managed
Certificate Request An object that represents the request for the Amazon CloudFront managed ACM certificate.
- Monitoring
Subscription A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
- Origin
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
S3OriginConfig
to specify an Amazon S3 bucket that is not configured with static website hosting. -
Use
VpcOriginConfig
to specify a VPC origin. -
Use
CustomOriginConfig
to specify all other kinds of origins, including:-
An Amazon S3 bucket that is configured with static website hosting
-
An Elastic Load Balancing load balancer
-
An Elemental MediaPackage endpoint
-
An 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).
-
- Origin
Access Control A CloudFront origin access control, including its unique identifier.
- Origin
Access Control Config A CloudFront origin access control configuration.
- Origin
Access Control List A list of CloudFront origin access controls.
- Origin
Access Control Summary A CloudFront origin access control.
- Origin
Custom Header A complex type that contains
HeaderName
andHeaderValue
elements, if any, for this distribution.- Origin
Group An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.
Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.
- Origin
Group Failover Criteria A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.
- Origin
Group Member An origin in an origin group.
- Origin
Group Members A complex data type for the origins included in an origin group.
- Origin
Groups A complex data type for the origin groups specified for a distribution.
- Origin
Request Policy An origin request policy.
When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
-
The request body and the URL path (without the domain name) from the viewer request.
-
The headers that CloudFront automatically includes in every origin request, including
Host
,User-Agent
, andX-Amz-Cf-Id
. -
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use
CachePolicy
.-
- Origin
Request Policy Config An origin request policy configuration.
This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
-
The request body and the URL path (without the domain name) from the viewer request.
-
The headers that CloudFront automatically includes in every origin request, including
Host
,User-Agent
, andX-Amz-Cf-Id
. -
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use
CachePolicy
.-
- Origin
Request Policy Cookies Config An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.
- Origin
Request Policy Headers Config An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.
- Origin
Request Policy List A list of origin request policies.
- Origin
Request Policy Query Strings Config An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.
- Origin
Request Policy Summary Contains an origin request policy.
- Origin
Shield 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.
- Origin
SslProtocols A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.
- Origins
Contains information about the origins for this distribution.
- Parameter
A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
- Parameter
Definition A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
- Parameter
Definition Schema An object that contains information about the parameter definition.
- Parameters
InCache KeyAnd Forwarded ToOrigin This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use
OriginRequestPolicy
.- Paths
A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.
- Public
Key A public key that you can use with signed URLs and signed cookies, or with field-level encryption.
- Public
KeyConfig Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
- Public
KeyList A list of public keys that you can use with signed URLs and signed cookies, or with field-level encryption.
- Public
KeySummary Contains information about a public key.
- Query
ArgProfile Query argument-profile mapping for field-level encryption.
- Query
ArgProfile Config Configuration for query argument-profile mapping for field-level encryption.
- Query
ArgProfiles Query argument-profile mapping for field-level encryption.
- Query
String Cache Keys 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
QueryStringsConfig
in a cache policy. SeeCachePolicy
.If you want to send query strings to the origin but not include them in the cache key, use
QueryStringsConfig
in an origin request policy. SeeOriginRequestPolicy
.A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.
- Query
String Names Contains a list of query string names.
- Realtime
LogConfig A real-time log configuration.
- Realtime
LogConfigs A list of real-time log configurations.
- Realtime
Metrics Subscription Config A subscription configuration for additional CloudWatch metrics.
- Response
Headers Policy A response headers policy.
A response headers policy contains information about a set of HTTP response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
- Response
Headers Policy Access Control Allow Headers A list of HTTP header names that CloudFront includes as values for the
Access-Control-Allow-Headers
HTTP response header.For more information about the
Access-Control-Allow-Headers
HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.- Response
Headers Policy Access Control Allow Methods A list of HTTP methods that CloudFront includes as values for the
Access-Control-Allow-Methods
HTTP response header.For more information about the
Access-Control-Allow-Methods
HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.- Response
Headers Policy Access Control Allow Origins A list of origins (domain names) that CloudFront can use as the value for the
Access-Control-Allow-Origin
HTTP response header.For more information about the
Access-Control-Allow-Origin
HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.- Response
Headers Policy Access Control Expose Headers A list of HTTP headers that CloudFront includes as values for the
Access-Control-Expose-Headers
HTTP response header.For more information about the
Access-Control-Expose-Headers
HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.- Response
Headers Policy Config A response headers policy configuration.
A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers.
- Response
Headers Policy Content Security Policy The policy directives and their values that CloudFront includes as values for the
Content-Security-Policy
HTTP response header.For more information about the
Content-Security-Policy
HTTP response header, see Content-Security-Policy in the MDN Web Docs.- Response
Headers Policy Content Type Options Determines whether CloudFront includes the
X-Content-Type-Options
HTTP response header with its value set tonosniff
.For more information about the
X-Content-Type-Options
HTTP response header, see X-Content-Type-Options in the MDN Web Docs.- Response
Headers Policy Cors Config A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.
For more information about CORS, see Cross-Origin Resource Sharing (CORS) in the MDN Web Docs.
- Response
Headers Policy Custom Header An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.
- Response
Headers Policy Custom Headers Config A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.
- Response
Headers Policy Frame Options Determines whether CloudFront includes the
X-Frame-Options
HTTP response header and the header's value.For more information about the
X-Frame-Options
HTTP response header, see X-Frame-Options in the MDN Web Docs.- Response
Headers Policy List A list of response headers policies.
- Response
Headers Policy Referrer Policy Determines whether CloudFront includes the
Referrer-Policy
HTTP response header and the header's value.For more information about the
Referrer-Policy
HTTP response header, see Referrer-Policy in the MDN Web Docs.- Response
Headers Policy Remove Header The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.
- Response
Headers Policy Remove Headers Config A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.
- Response
Headers Policy Security Headers Config A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy.
- Response
Headers Policy Server Timing Headers Config A configuration for enabling the
Server-Timing
header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.You can use the
Server-Timing
header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in theServer-Timing
header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.- Response
Headers Policy Strict Transport Security Determines whether CloudFront includes the
Strict-Transport-Security
HTTP response header and the header's value.For more information about the
Strict-Transport-Security
HTTP response header, see Strict-Transport-Security in the MDN Web Docs.- Response
Headers Policy Summary Contains a response headers policy.
- Response
Headers Policy XssProtection Determines whether CloudFront includes the
X-XSS-Protection
HTTP response header and the header's value.For more information about the
X-XSS-Protection
HTTP response header, see X-XSS-Protection in the MDN Web Docs.- Restrictions
A complex type that identifies ways in which you want to restrict distribution of your content.
- S3Origin
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
- S3Origin
Config A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the
CustomOriginConfig
element instead.- Session
Stickiness Config Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
- Signer
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Staging
Distribution DnsNames The CloudFront domain name of the staging distribution.
- Status
Codes A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.
- Streaming
Distribution A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.
- Streaming
Distribution Config The RTMP distribution's configuration information.
- Streaming
Distribution Config With Tags A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.
- Streaming
Distribution List A streaming distribution list.
- Streaming
Distribution Summary A summary of the information for a CloudFront streaming distribution.
- Streaming
Logging Config A complex type that controls whether access logs are written for this streaming distribution.
- String
Schema Config The configuration for a string schema.
- Tag
A complex type that contains
Tag
key andTag
value.- TagKeys
A complex type that contains zero or more
Tag
elements.- Tags
A complex type that contains zero or more
Tag
elements.- Tenant
Config The configuration for a distribution tenant.
- Test
Result Contains the result of testing a CloudFront function with
TestFunction
.- Traffic
Config The traffic configuration of your continuous deployment.
- Trusted
KeyGroups A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Trusted
Signers A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Validation
Token Detail Contains details about the validation token.
- Viewer
Certificate A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
If the distribution doesn't use
Aliases
(also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty.If the distribution uses
Aliases
(alternate domain names or CNAMEs), use the fields in this type to specify the following settings:-
Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don't support SNI.
-
To accept HTTPS connections from only viewers that support SNI, set
SSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. -
To accept HTTPS connections from all viewers, including those that don't support SNI, set
SSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront.
-
-
The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for
MinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. -
The location of the SSL/TLS certificate, Certificate Manager (ACM) (recommended) or Identity and Access Management (IAM). You specify the location by setting a value in one of the following fields (not both):
-
ACMCertificateArn
-
IAMCertificateId
-
All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use
ViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
.For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
-
- VpcOrigin
An Amazon CloudFront VPC origin.
- VpcOrigin
Config An Amazon CloudFront VPC origin configuration.
- VpcOrigin
Endpoint Config An Amazon CloudFront VPC origin endpoint configuration.
- VpcOrigin
List A list of CloudFront VPC origins.
- VpcOrigin
Summary A summary of the CloudFront VPC origin.
- WebAcl
Customization The WAF web ACL customization specified for the distribution tenant.
Enums§
- Cache
Policy Cookie Behavior - When writing a match expression against
CachePolicyCookieBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Policy Header Behavior - When writing a match expression against
CachePolicyHeaderBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Policy Query String Behavior - When writing a match expression against
CachePolicyQueryStringBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Policy Type - When writing a match expression against
CachePolicyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Certificate
Source - When writing a match expression against
CertificateSource
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Certificate
Transparency Logging Preference - When writing a match expression against
CertificateTransparencyLoggingPreference
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Connection
Mode - When writing a match expression against
ConnectionMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Continuous
Deployment Policy Type - When writing a match expression against
ContinuousDeploymentPolicyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Customization
Action Type - When writing a match expression against
CustomizationActionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Distribution
Resource Type - When writing a match expression against
DistributionResourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - DnsConfiguration
Status - When writing a match expression against
DnsConfigurationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Domain
Status - When writing a match expression against
DomainStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Type - When writing a match expression against
EventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Format
- When writing a match expression against
Format
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Frame
Options List - When writing a match expression against
FrameOptionsList
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Function
Runtime - When writing a match expression against
FunctionRuntime
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Function
Stage - When writing a match expression against
FunctionStage
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - GeoRestriction
Type - When writing a match expression against
GeoRestrictionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Http
Version - When writing a match expression against
HttpVersion
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IcpRecordal
Status - When writing a match expression against
IcpRecordalStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Import
Source Type - When writing a match expression against
ImportSourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Item
Selection - When writing a match expression against
ItemSelection
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Managed
Certificate Status - When writing a match expression against
ManagedCertificateStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Method
- When writing a match expression against
Method
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Minimum
Protocol Version - When writing a match expression against
MinimumProtocolVersion
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Access Control Origin Types - When writing a match expression against
OriginAccessControlOriginTypes
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Access Control Signing Behaviors - When writing a match expression against
OriginAccessControlSigningBehaviors
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Access Control Signing Protocols - When writing a match expression against
OriginAccessControlSigningProtocols
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Group Selection Criteria - When writing a match expression against
OriginGroupSelectionCriteria
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Protocol Policy - When writing a match expression against
OriginProtocolPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Request Policy Cookie Behavior - When writing a match expression against
OriginRequestPolicyCookieBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Request Policy Header Behavior - When writing a match expression against
OriginRequestPolicyHeaderBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Request Policy Query String Behavior - When writing a match expression against
OriginRequestPolicyQueryStringBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Request Policy Type - When writing a match expression against
OriginRequestPolicyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Price
Class - When writing a match expression against
PriceClass
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Realtime
Metrics Subscription Status - When writing a match expression against
RealtimeMetricsSubscriptionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Referrer
Policy List - When writing a match expression against
ReferrerPolicyList
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Response
Headers Policy Access Control Allow Methods Values - When writing a match expression against
ResponseHeadersPolicyAccessControlAllowMethodsValues
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Response
Headers Policy Type - When writing a match expression against
ResponseHeadersPolicyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - SslProtocol
- When writing a match expression against
SslProtocol
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - SslSupport
Method - When writing a match expression against
SslSupportMethod
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Validation
Token Host - When writing a match expression against
ValidationTokenHost
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Viewer
Protocol Policy - When writing a match expression against
ViewerProtocolPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.