Boolean enabled
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.
Integer quantity
The number of key groups in the list.
SdkInternalList<T> items
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.
Boolean enabled
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key
pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is
false.
Integer quantity
The number of Amazon Web Services accounts in the list.
SdkInternalList<T> items
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.
Integer quantity
The number of CNAME aliases, if any, that you want to associate with this distribution.
SdkInternalList<T> items
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
String cNAME
A domain name associated with a distribution.
String iCPRecordalStatus
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.
Integer quantity
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).
SdkInternalList<T> items
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods cachedMethods
String pathPattern
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.
String targetOriginId
The value of ID for the origin that you want CloudFront to route requests to when they match this
cache behavior.
TrustedSigners trustedSigners
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.
TrustedKeyGroups trustedKeyGroups
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.
String viewerProtocolPolicy
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.
AllowedMethods allowedMethods
Boolean smoothStreaming
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.
Boolean compress
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
LambdaFunctionAssociations lambdaFunctionAssociations
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
FunctionAssociations functionAssociations
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.
String fieldLevelEncryptionId
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.
String realtimeLogConfigArn
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.
String cachePolicyId
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.
String originRequestPolicyId
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.
String responseHeadersPolicyId
The identifier for a response headers policy.
ForwardedValues forwardedValues
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.
Long minTTL
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).
Long defaultTTL
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.
Long maxTTL
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.
Integer quantity
The number of cache behaviors for this distribution.
SdkInternalList<T> items
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is
0, you can omit Items.
Integer quantity
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).
SdkInternalList<T> items
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
String id
The unique identifier for the cache policy.
Date lastModifiedTime
The date and time when the cache policy was last modified.
CachePolicyConfig cachePolicyConfig
The cache policy configuration.
String comment
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
String name
A unique name to identify the cache policy.
Long defaultTTL
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront
sends another request to the origin to see if the object has been updated. CloudFront uses this value as the
object’s time to live (TTL) only when the origin does not send Cache-Control or
Expires headers with the object. For more information, see Managing How Long
Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than
86400 seconds, then the default value for this field is the same as the value of MinTTL.
Long maxTTL
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another
request to the origin to see if the object has been updated. CloudFront uses this value only when the origin
sends Cache-Control or Expires headers with the object. For more information, see Managing How Long
Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or
DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the
value of DefaultTTL.
Long minTTL
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
String cookieBehavior
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically
included in requests that CloudFront sends to the origin. Even when this field is set to none, any
cookies that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – The cookies in viewer requests that are listed in the CookieNames type are
included in the cache key and automatically included in requests that CloudFront sends to the origin.
allExcept – All cookies in viewer requests that are not listed in the
CookieNames type are included in the cache key and automatically included in requests that
CloudFront sends to the origin.
all – All cookies in viewer requests are included in the cache key and are automatically included in
requests that CloudFront sends to the origin.
CookieNames cookies
String headerBehavior
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests
that CloudFront sends to the origin. Even when this field is set to none, any headers that are
listed in an OriginRequestPolicy are included in origin requests.
whitelist – The HTTP headers that are listed in the Headers type are included in the
cache key and are automatically included in requests that CloudFront sends to the origin.
Headers headers
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing cache policies
where you left off.
Integer maxItems
The maximum number of cache policies requested.
Integer quantity
The total number of cache policies returned in the response.
SdkInternalList<T> items
Contains the cache policies in the list.
String queryStringBehavior
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically
included in requests that CloudFront sends to the origin. Even when this field is set to none, any
query strings that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – The query strings in viewer requests that are listed in the
QueryStringNames type are included in the cache key and automatically included in requests that
CloudFront sends to the origin.
allExcept – All query strings in viewer requests that are not listed in the
QueryStringNames type are included in the cache key and automatically included in requests that
CloudFront sends to the origin.
all – All query strings in viewer requests are included in the cache key and are automatically
included in requests that CloudFront sends to the origin.
QueryStringNames queryStrings
Contains the specific query strings in viewer requests that either are or are not
included in the cache key and automatically included in requests that CloudFront sends to the origin. The
behavior depends on whether the QueryStringBehavior field in the
CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings
are included) or allExcept (the listed query strings are not included,
but all other query strings are).
String type
The type of cache policy, either managed (created by Amazon Web Services) or custom
(created in this Amazon Web Services account).
CachePolicy cachePolicy
The cache policy.
String id
The ID for the origin access identity, for example, E74FTE3AJFJ256A.
String s3CanonicalUserId
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
String callerReference
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
CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, and the content of
the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white
space), the response includes the same information returned to the original request.
If the CallerReference is a value you already sent in a previous request to create an identity, but
the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,
CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
String comment
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
String marker
Use this when paginating results to indicate where to begin in your list of origin access identities. The results
include identities in the list that occur after the marker. To get the next page of results, set the
Marker to the value of the NextMarker from the current page's response (which is also
the ID of the last identity on that page).
String nextMarker
If IsTruncated is true, this element is present and contains the value you can use for
the Marker request parameter to continue listing your origin access identities where they left off.
Integer maxItems
The maximum number of origin access identities you want in the response body.
Boolean isTruncated
A flag that indicates whether more origin access identities remain to be listed. If your results were truncated,
you can make a follow-up pagination request using the Marker request parameter to retrieve more
items in the list.
Integer quantity
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
SdkInternalList<T> items
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin
access identity that was created by the current Amazon Web Services account.
String id
The ID for the origin access identity. For example: E74FTE3AJFJ256A.
String s3CanonicalUserId
The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
String comment
The comment for this origin access identity, as originally specified when created.
String alias
An alias (also called a CNAME).
String distributionId
The (partially hidden) ID of the CloudFront distribution associated with the alias.
String accountId
The (partially hidden) ID of the Amazon Web Services account that owns the distribution that’s associated with the alias.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing conflicting
aliases where you left off.
Integer maxItems
The maximum number of conflicting aliases requested.
Integer quantity
The number of conflicting aliases returned in the response.
SdkInternalList<T> items
Contains the conflicting aliases in the list.
Boolean forwardWhenContentTypeIsUnknown
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
ContentTypeProfiles contentTypeProfiles
The configuration for a field-level encryption content type-profile.
Integer quantity
The number of field-level encryption content type-profile mappings.
SdkInternalList<T> items
Items in a field-level encryption content type-profile mapping.
Integer quantity
The number of cookie names in the Items list.
SdkInternalList<T> items
A list of cookie names.
String forward
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.
CookieNames whitelistedNames
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.
CachePolicyConfig cachePolicyConfig
A cache policy configuration.
CachePolicy cachePolicy
A cache policy.
String location
The fully qualified URI of the cache policy just created.
String eTag
The current version of the cache policy.
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
The origin access identity's information.
String location
The fully qualified URI of the new origin access identity just created.
String eTag
The current version of the origin access identity created.
DistributionConfig distributionConfig
The distribution's configuration information.
Distribution distribution
The distribution's information.
String location
The fully qualified URI of the new distribution resource just created.
String eTag
The current version of the distribution created.
DistributionConfigWithTags distributionConfigWithTags
The distribution's configuration information.
Distribution distribution
The distribution's information.
String location
The fully qualified URI of the new distribution resource just created.
String eTag
The current version of the distribution created.
FieldLevelEncryptionConfig fieldLevelEncryptionConfig
The request to create a new field-level encryption configuration.
FieldLevelEncryption fieldLevelEncryption
Returned when you create a new field-level encryption configuration.
String location
The fully qualified URI of the new configuration resource just created.
String eTag
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig
The request to create a field-level encryption profile.
FieldLevelEncryptionProfile fieldLevelEncryptionProfile
Returned when you create a new field-level encryption profile.
String location
The fully qualified URI of the new profile resource just created.
String eTag
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
String name
A name to identify the function.
FunctionConfig functionConfig
Configuration information about the function, including an optional comment and the function’s runtime.
ByteBuffer functionCode
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
FunctionSummary functionSummary
Contains configuration information and metadata about a CloudFront function.
String location
The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
String eTag
The version identifier for the current version of the CloudFront function.
String distributionId
The distribution's id.
InvalidationBatch invalidationBatch
The batch information for the invalidation.
String location
The fully qualified URI of the distribution and invalidation batch request, including the
Invalidation ID.
Invalidation invalidation
The invalidation's information.
KeyGroupConfig keyGroupConfig
A key group configuration.
String distributionId
The ID of the distribution that you are enabling metrics for.
MonitoringSubscription monitoringSubscription
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
MonitoringSubscription monitoringSubscription
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
OriginAccessControlConfig originAccessControlConfig
Contains the origin access control.
OriginAccessControl originAccessControl
Contains an origin access control.
String location
The URL of the origin access control.
String eTag
The version identifier for the current version of the origin access control.
OriginRequestPolicyConfig originRequestPolicyConfig
An origin request policy configuration.
OriginRequestPolicy originRequestPolicy
An origin request policy.
String location
The fully qualified URI of the origin request policy just created.
String eTag
The current version of the origin request policy.
PublicKeyConfig publicKeyConfig
A CloudFront public key configuration.
SdkInternalList<T> endPoints
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
SdkInternalList<T> fields
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
String name
A unique name to identify this real-time log configuration.
Long samplingRate
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
RealtimeLogConfig realtimeLogConfig
A real-time log configuration.
ResponseHeadersPolicyConfig responseHeadersPolicyConfig
Contains metadata about the response headers policy, and a set of configurations that specify the response headers.
ResponseHeadersPolicy responseHeadersPolicy
Contains a response headers policy.
String location
The URL of the response headers policy.
String eTag
The version identifier for the current version of the response headers policy.
StreamingDistributionConfig streamingDistributionConfig
The streaming distribution's configuration information.
StreamingDistribution streamingDistribution
The streaming distribution's information.
String location
The fully qualified URI of the new streaming distribution resource just created.
String eTag
The current version of the streaming distribution created.
StreamingDistributionConfigWithTags streamingDistributionConfigWithTags
The streaming distribution's configuration information.
StreamingDistribution streamingDistribution
The streaming distribution's information.
String location
The fully qualified URI of the new streaming distribution resource just created.
String eTag
The current version of the distribution created.
Integer errorCode
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
String responsePagePath
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.
String responseCode
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.
Long errorCachingMinTTL
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.
Integer quantity
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.
SdkInternalList<T> items
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.
Integer quantity
The number of custom headers, if any, for this distribution.
SdkInternalList<T> items
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.
Integer hTTPPort
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
Integer hTTPSPort
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
String originProtocolPolicy
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.
match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to
connect to CloudFront.
https-only – CloudFront always uses HTTPS to connect to the origin.
OriginSslProtocols originSslProtocols
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.
Integer originReadTimeout
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.
Integer originKeepaliveTimeout
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.
String targetOriginId
The value of ID for the origin that you want CloudFront to route requests to when they use the
default cache behavior.
TrustedSigners trustedSigners
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.
TrustedKeyGroups trustedKeyGroups
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.
String viewerProtocolPolicy
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.
AllowedMethods allowedMethods
Boolean smoothStreaming
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.
Boolean compress
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true; if not, specify false. For more information, see Serving
Compressed Files in the Amazon CloudFront Developer Guide.
LambdaFunctionAssociations lambdaFunctionAssociations
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
FunctionAssociations functionAssociations
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.
String fieldLevelEncryptionId
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.
String realtimeLogConfigArn
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.
String cachePolicyId
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.
String originRequestPolicyId
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.
String responseHeadersPolicyId
The identifier for a response headers policy.
ForwardedValues forwardedValues
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.
Long minTTL
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).
Long defaultTTL
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.
Long maxTTL
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.
String id
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use
ListCachePolicies.
String ifMatch
The version of the cache policy that you are deleting. The version is the cache policy’s ETag value,
which you can get using ListCachePolicies, GetCachePolicy, or
GetCachePolicyConfig.
String distributionId
The ID of the distribution that you are disabling metrics for.
String id
The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use
ListOriginRequestPolicies.
String ifMatch
The version of the origin request policy that you are deleting. The version is the origin request policy’s
ETag value, which you can get using ListOriginRequestPolicies,
GetOriginRequestPolicy, or GetOriginRequestPolicyConfig.
String id
The identifier for the response headers policy that you are deleting.
To get the identifier, you can use ListResponseHeadersPolicies.
String ifMatch
The version of the response headers policy that you are deleting.
The version is the response headers policy’s ETag value, which you can get using
ListResponseHeadersPolicies, GetResponseHeadersPolicy, or
GetResponseHeadersPolicyConfig.
FunctionSummary functionSummary
Contains configuration information and metadata about a CloudFront function.
String eTag
The version identifier for the current version of the CloudFront function.
String id
The identifier for the distribution. For example: EDFDVBD632BHDS5.
String aRN
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
your Amazon Web Services account ID.
String status
This response element indicates the current status of the distribution. When the status is Deployed,
the distribution's information is fully propagated to all CloudFront edge locations.
Date lastModifiedTime
The date and time the distribution was last modified.
Integer inProgressInvalidationBatches
The number of invalidation batches currently in progress.
String domainName
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
ActiveTrustedSigners activeTrustedSigners
We recommend using TrustedKeyGroups instead of TrustedSigners.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. 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.
ActiveTrustedKeyGroups activeTrustedKeyGroups
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. 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.
DistributionConfig distributionConfig
The current configuration information for the distribution. Send a GET request to the
/CloudFront API version/distribution ID/config resource.
SdkInternalList<T> aliasICPRecordals
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.
String callerReference
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.
Aliases aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
String defaultRootObject
The object that you want CloudFront to request from your origin (for example, index.html) when a
viewer requests the root URL for your distribution (http://www.example.com) instead of an object in
your distribution (http://www.example.com/product-description.html). Specifying a default root
object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html. Don't add a / before the object
name.
If you don't want to specify a default root object when you create a distribution, include an empty
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.
Origins origins
A complex type that contains information about origins for this distribution.
OriginGroups originGroups
A complex type that contains information about origin groups for this distribution.
DefaultCacheBehavior defaultCacheBehavior
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.
CacheBehaviors cacheBehaviors
A complex type that contains zero or more CacheBehavior elements.
CustomErrorResponses customErrorResponses
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.
String comment
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
LoggingConfig logging
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.
String priceClass
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.
Boolean enabled
From this field, you can enable or disable the selected distribution.
ViewerCertificate viewerCertificate
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
Restrictions restrictions
A complex type that identifies ways in which you want to restrict distribution of your content.
String webACLId
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/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a.
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.
String httpVersion
(Optional) Specify the maximum 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.
Boolean isIPV6Enabled
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.
DistributionConfig distributionConfig
A distribution configuration.
Tags tags
A complex type that contains zero or more Tag elements.
String marker
The value provided in the Marker request field.
String nextMarker
Contains the value that you should use in the Marker field of a subsequent request to continue
listing distribution IDs where you left off.
Integer maxItems
The maximum number of distribution IDs requested.
Boolean isTruncated
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can
make a subsequent request using the Marker request field to retrieve more distribution IDs in the
list.
Integer quantity
The total number of distribution IDs returned in the response.
SdkInternalList<T> items
Contains the distribution IDs in the list.
String marker
The value you provided for the Marker request parameter.
String nextMarker
If IsTruncated is true, this element is present and contains the value you can use for
the Marker request parameter to continue listing your distributions where they left off.
Integer maxItems
The value you provided for the MaxItems request parameter.
Boolean isTruncated
A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can
make a follow-up pagination request using the Marker request parameter to retrieve more
distributions in the list.
Integer quantity
The number of distributions that were created by the current Amazon Web Services account.
SdkInternalList<T> items
A complex type that contains one DistributionSummary element for each distribution that was created
by the current Amazon Web Services account.
String id
The identifier for the distribution. For example: EDFDVBD632BHDS5.
String aRN
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
your Amazon Web Services account ID.
String status
The current status of the distribution. When the status is Deployed, the distribution's information
is propagated to all CloudFront edge locations.
Date lastModifiedTime
The date and time the distribution was last modified.
String domainName
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.
Aliases aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Origins origins
A complex type that contains information about origins for this distribution.
OriginGroups originGroups
A complex type that contains information about origin groups for this distribution.
DefaultCacheBehavior defaultCacheBehavior
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.
CacheBehaviors cacheBehaviors
A complex type that contains zero or more CacheBehavior elements.
CustomErrorResponses customErrorResponses
A complex type that contains zero or more CustomErrorResponses elements.
String comment
The comment originally specified when this distribution was created.
String priceClass
A complex type that contains information about price class for this streaming distribution.
Boolean enabled
Whether the distribution is enabled to accept user requests for content.
ViewerCertificate viewerCertificate
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
Restrictions restrictions
A complex type that identifies ways in which you want to restrict distribution of your content.
String webACLId
The Web ACL Id (if any) associated with the distribution.
String httpVersion
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value
for new web distributions is http2. Viewers that don't support HTTP/2 will
automatically use an earlier version.
Boolean isIPV6Enabled
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
SdkInternalList<T> aliasICPRecordals
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.
Integer quantity
Number of field pattern items in a field-level encryption content type-profile mapping.
SdkInternalList<T> items
An array of field patterns in a field-level encryption content type-profile mapping.
String publicKeyId
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
String providerId
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
FieldPatterns fieldPatterns
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
String streamType
The type of data stream where you are sending real-time log data. The only valid value is Kinesis.
KinesisStreamConfig kinesisStreamConfig
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
String id
The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
Date lastModifiedTime
The last time the field-level encryption configuration was changed.
FieldLevelEncryptionConfig fieldLevelEncryptionConfig
A complex data type that includes the profile configurations specified for field-level encryption.
String callerReference
A unique number that ensures the request can't be replayed.
String comment
An optional comment about the configuration. The comment cannot be longer than 128 characters.
QueryArgProfileConfig queryArgProfileConfig
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
ContentTypeProfileConfig contentTypeProfileConfig
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
String nextMarker
If there are more elements to be listed, this element is present and contains the value that you can use for the
Marker request parameter to continue listing your configurations where you left off.
Integer maxItems
The maximum number of elements you want in the response body.
Integer quantity
The number of field-level encryption items.
SdkInternalList<T> items
An array of field-level encryption items.
String id
The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
Date lastModifiedTime
The last time the field-level encryption profile was updated.
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig
A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
String name
Profile name for the field-level encryption profile.
String callerReference
A unique number that ensures that the request can't be replayed.
String comment
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
EncryptionEntities encryptionEntities
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
String nextMarker
If there are more elements to be listed, this element is present and contains the value that you can use for the
Marker request parameter to continue listing your profiles where you left off.
Integer maxItems
The maximum number of field-level encryption profiles you want in the response body.
Integer quantity
The number of field-level encryption profiles.
SdkInternalList<T> items
The field-level encryption profile items.
String id
ID for the field-level encryption profile summary.
Date lastModifiedTime
The time when the the field-level encryption profile summary was last updated.
String name
Name for the field-level encryption profile summary.
EncryptionEntities encryptionEntities
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
String comment
An optional comment for the field-level encryption profile summary. The comment cannot be longer than 128 characters.
String id
The unique ID of a field-level encryption item.
Date lastModifiedTime
The last time that the summary of field-level encryption items was modified.
String comment
An optional comment about the field-level encryption item. The comment cannot be longer than 128 characters.
QueryArgProfileConfig queryArgProfileConfig
A summary of a query argument-profile mapping.
ContentTypeProfileConfig contentTypeProfileConfig
A summary of a content type-profile mapping.
Integer quantity
The number of field-level encryption field patterns.
SdkInternalList<T> items
An array of the field-level encryption field patterns.
Boolean queryString
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.
CookiePreference cookies
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.
Headers headers
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.
QueryStringCacheKeys queryStringCacheKeys
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.
Integer quantity
The number of CloudFront functions in the list.
SdkInternalList<T> items
The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront
functions must be published to the LIVE stage to associate them with a cache behavior.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing functions where
you left off.
Integer maxItems
The maximum number of functions requested.
Integer quantity
The number of functions returned in the response.
SdkInternalList<T> items
Contains the functions in the list.
String functionARN
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
String stage
The stage that the function is in, either DEVELOPMENT or LIVE.
When a function is in the DEVELOPMENT stage, you can test the function with
TestFunction, and update it with UpdateFunction.
When a function is in the LIVE stage, you can attach the function to a distribution’s cache
behavior, using the function’s ARN.
Date createdTime
The date and time when the function was created.
Date lastModifiedTime
The date and time when the function was most recently updated.
String name
The name of the CloudFront function.
String status
The status of the CloudFront function.
FunctionConfig functionConfig
Contains configuration information about a CloudFront function.
FunctionMetadata functionMetadata
Contains metadata about a CloudFront function.
String restrictionType
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.
Integer quantity
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.
SdkInternalList<T> items
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.
String id
The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior,
you can get the policy’s identifier using ListDistributions or GetDistribution. If the
cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies
.
CachePolicyConfig cachePolicyConfig
The cache policy configuration.
String eTag
The current version of the cache policy.
String id
The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior,
you can get the policy’s identifier using ListDistributions or GetDistribution. If the
cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies
.
CachePolicy cachePolicy
The cache policy.
String eTag
The current version of the cache policy.
String id
The identity's ID.
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
The origin access identity's configuration information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
String id
The identity's ID.
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
The origin access identity's information.
String eTag
The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
String id
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
DistributionConfig distributionConfig
The distribution's configuration information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
String id
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
Distribution distribution
The distribution's information.
String eTag
The current version of the distribution's information. For example: E2QWRUHAPOMQZL.
String id
Request the ID for the field-level encryption configuration information.
FieldLevelEncryptionConfig fieldLevelEncryptionConfig
Return the field-level encryption configuration information.
String eTag
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
String id
Get the ID for the field-level encryption profile configuration information.
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig
Return the field-level encryption profile configuration information.
String eTag
The current version of the field-level encryption profile configuration result. For example:
E2QWRUHAPOMQZL.
String id
Get the ID for the field-level encryption profile information.
FieldLevelEncryptionProfile fieldLevelEncryptionProfile
Return the field-level encryption profile information.
String eTag
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
String id
Request the ID for the field-level encryption configuration information.
FieldLevelEncryption fieldLevelEncryption
Return the field-level encryption configuration information.
String eTag
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
ByteBuffer functionCode
The function code of a CloudFront function.
String eTag
The version identifier for the current version of the CloudFront function.
String contentType
The content type (media type) of the response.
Invalidation invalidation
The invalidation's information. For more information, see Invalidation Complex Type.
String id
The identifier of the key group whose configuration you are getting. To get the identifier, use
ListKeyGroups.
KeyGroupConfig keyGroupConfig
The key group configuration.
String eTag
The identifier for this version of the key group.
String id
The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.
String distributionId
The ID of the distribution that you are getting metrics information for.
MonitoringSubscription monitoringSubscription
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
String id
The unique identifier of the origin access control.
OriginAccessControlConfig originAccessControlConfig
Contains an origin access control configuration.
String eTag
The version identifier for the current version of the origin access control.
String id
The unique identifier of the origin access control.
OriginAccessControl originAccessControl
Contains an origin access control, including its unique identifier.
String eTag
The version identifier for the current version of the origin access control.
String id
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s
cache behavior, you can get the policy’s identifier using ListDistributions or
GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the
identifier using ListOriginRequestPolicies.
OriginRequestPolicyConfig originRequestPolicyConfig
The origin request policy configuration.
String eTag
The current version of the origin request policy.
String id
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s
cache behavior, you can get the policy’s identifier using ListDistributions or
GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the
identifier using ListOriginRequestPolicies.
OriginRequestPolicy originRequestPolicy
The origin request policy.
String eTag
The current version of the origin request policy.
String id
The identifier of the public key whose configuration you are getting.
PublicKeyConfig publicKeyConfig
A public key configuration.
String eTag
The identifier for this version of the public key configuration.
String id
The identifier of the public key you are getting.
RealtimeLogConfig realtimeLogConfig
A real-time log configuration.
String id
The identifier for the response headers policy.
If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s
identifier using ListDistributions or GetDistribution. If the response headers policy
is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
ResponseHeadersPolicyConfig responseHeadersPolicyConfig
Contains a response headers policy.
String eTag
The version identifier for the current version of the response headers policy.
String id
The identifier for the response headers policy.
If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s
identifier using ListDistributions or GetDistribution. If the response headers policy
is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
ResponseHeadersPolicy responseHeadersPolicy
Contains a response headers policy.
String eTag
The version identifier for the current version of the response headers policy.
String id
The streaming distribution's ID.
StreamingDistributionConfig streamingDistributionConfig
The streaming distribution's configuration information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
String id
The streaming distribution's ID.
StreamingDistribution streamingDistribution
The streaming distribution's information.
String eTag
The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
Integer quantity
The number of header names in the Items list.
SdkInternalList<T> items
A list of HTTP header names.
String id
The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
String status
The status of the invalidation request. When the invalidation batch is finished, the status is
Completed.
Date createTime
The date and time the invalidation request was first made.
InvalidationBatch invalidationBatch
The current invalidation information for the batch request.
Paths 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.
String callerReference
A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you
from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must
specify a new value for CallerReference and change other values in the request as applicable. One
way to ensure that the value of CallerReference is unique is to use a timestamp, for
example, 20120301090000.
If you make a second invalidation request with the same value for CallerReference, and if the rest
of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns
information about the invalidation request that you previously created with the same CallerReference
.
If CallerReference is a value you already sent in a previous invalidation batch request but the
content of any Path is different from the original request, CloudFront returns an
InvalidationBatchAlreadyExists error.
String marker
The value that you provided for the Marker request parameter.
String nextMarker
If IsTruncated is true, this element is present and contains the value that you can use
for the Marker request parameter to continue listing your invalidation batches where they left off.
Integer maxItems
The value that you provided for the MaxItems request parameter.
Boolean isTruncated
A flag that indicates whether more invalidation batch requests remain to be listed. If your results were
truncated, you can make a follow-up pagination request using the Marker request parameter to
retrieve more invalidation batches in the list.
Integer quantity
The number of invalidation batches that were created by the current Amazon Web Services account.
SdkInternalList<T> items
A complex type that contains one InvalidationSummary element for each invalidation batch created by
the current Amazon Web Services account.
String id
The identifier for the key group.
Date lastModifiedTime
The date and time when the key group was last modified.
KeyGroupConfig keyGroupConfig
The key group configuration.
String name
A name to identify the key group.
SdkInternalList<T> items
A list of the identifiers of the public keys in the key group.
String comment
A comment to describe the key group. The comment cannot be longer than 128 characters.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing key groups.
Integer maxItems
The maximum number of key groups requested.
Integer quantity
The number of key groups returned in the response.
SdkInternalList<T> items
A list of key groups.
KeyGroup keyGroup
A key group.
Integer quantity
The number of key pair identifiers in the list.
SdkInternalList<T> items
A list of CloudFront key pair identifiers.
String keyGroupId
The identifier of the key group that contains the public keys.
KeyPairIds keyPairIds
String roleARN
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide.
String streamARN
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
String lambdaFunctionARN
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
String eventType
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.
Boolean includeBody
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.
Integer quantity
The number of Lambda@Edge function associations for this cache behavior.
SdkInternalList<T> items
Optional: A complex type that contains LambdaFunctionAssociation items for this cache
behavior. If Quantity is 0, you can omit Items.
String type
A filter to return only the specified kinds of cache policies. Valid values are:
managed – Returns only the managed policies created by Amazon Web Services.
custom – Returns only the custom policies created in your Amazon Web Services account.
String marker
Use this field when paginating results to indicate where to begin in your list of cache policies. The response
includes cache policies in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of cache policies that you want in the response.
CachePolicyList cachePolicyList
A list of cache policies.
String marker
Use this when paginating results to indicate where to begin in your list of origin access identities. The results
include identities in the list that occur after the marker. To get the next page of results, set the
Marker to the value of the NextMarker from the current page's response (which is also
the ID of the last identity on that page).
String maxItems
The maximum number of origin access identities you want in the response body.
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
The CloudFrontOriginAccessIdentityList type.
String distributionId
The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
String alias
The alias (also called a CNAME) to search for conflicting aliases.
String marker
Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The
response includes conflicting aliases in the list that occur after the marker. To get the next page of the list,
set this field’s value to the value of NextMarker from the current page’s response.
Integer maxItems
The maximum number of conflicting aliases that you want in the response.
ConflictingAliasesList conflictingAliasesList
A list of conflicting aliases.
String marker
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response
includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of distribution IDs that you want in the response.
String cachePolicyId
The ID of the cache policy whose associated distribution IDs you want to list.
DistributionIdList distributionIdList
A list of distribution IDs.
String marker
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response
includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of distribution IDs that you want in the response.
String keyGroupId
The ID of the key group whose associated distribution IDs you are listing.
DistributionIdList distributionIdList
String marker
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response
includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of distribution IDs that you want in the response.
String originRequestPolicyId
The ID of the origin request policy whose associated distribution IDs you want to list.
DistributionIdList distributionIdList
A list of distribution IDs.
String marker
Use this field when paginating results to indicate where to begin in your list of distributions. The response
includes distributions in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of distributions that you want in the response.
String realtimeLogConfigName
The name of the real-time log configuration whose associated distributions you want to list.
String realtimeLogConfigArn
The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.
DistributionList distributionList
String marker
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response
includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this
field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of distribution IDs that you want to get in the response.
String responseHeadersPolicyId
The ID of the response headers policy whose associated distribution IDs you want to list.
DistributionIdList distributionIdList
String marker
Use Marker and MaxItems to control pagination of results. If you have more than
MaxItems distributions that satisfy the request, the response includes a NextMarker
element. To get the next page of results, submit another request. For the value of Marker, specify
the value of NextMarker from the last response. (For the first request, omit Marker.)
String maxItems
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
String webACLId
The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
DistributionList distributionList
The DistributionList type.
String marker
Use this when paginating results to indicate where to begin in your list of distributions. The results include
distributions in the list that occur after the marker. To get the next page of results, set the
Marker to the value of the NextMarker from the current page's response (which is also
the ID of the last distribution on that page).
String maxItems
The maximum number of distributions you want in the response body.
DistributionList distributionList
The DistributionList type.
String marker
Use this when paginating results to indicate where to begin in your list of configurations. The results include
configurations in the list that occur after the marker. To get the next page of results, set the
Marker to the value of the NextMarker from the current page's response (which is also
the ID of the last configuration on that page).
String maxItems
The maximum number of field-level encryption configurations you want in the response body.
FieldLevelEncryptionList fieldLevelEncryptionList
Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
String marker
Use this when paginating results to indicate where to begin in your list of profiles. The results include
profiles in the list that occur after the marker. To get the next page of results, set the Marker to
the value of the NextMarker from the current page's response (which is also the ID of the last
profile on that page).
String maxItems
The maximum number of field-level encryption profiles you want in the response body.
FieldLevelEncryptionProfileList fieldLevelEncryptionProfileList
Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
String marker
Use this field when paginating results to indicate where to begin in your list of functions. The response
includes functions in the list that occur after the marker. To get the next page of the list, set this field’s
value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of functions that you want in the response.
String stage
An optional filter to return only the functions that are in the specified stage, either DEVELOPMENT
or LIVE.
FunctionList functionList
A list of CloudFront functions.
String distributionId
The distribution's ID.
String marker
Use this parameter when paginating results to indicate where to begin in your list of invalidation batches.
Because the results are returned in decreasing order from most recent to oldest, the most recent results are on
the first page, the second page will contain earlier results, and so on. To get the next page of results, set
Marker to the value of the NextMarker from the current page's response. This value is
the same as the ID of the last invalidation batch on that page.
String maxItems
The maximum number of invalidation batches that you want in the response body.
InvalidationList invalidationList
Information about invalidation batches.
String marker
Use this field when paginating results to indicate where to begin in your list of key groups. The response
includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s
value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of key groups that you want in the response.
KeyGroupList keyGroupList
A list of key groups.
String marker
Use this field when paginating results to indicate where to begin in your list of origin access controls. The
response includes the items in the list that occur after the marker. To get the next page of the list, set this
field's value to the value of NextMarker from the current page's response.
String maxItems
The maximum number of origin access controls that you want in the response.
OriginAccessControlList originAccessControlList
A list of origin access controls.
String type
A filter to return only the specified kinds of origin request policies. Valid values are:
managed – Returns only the managed policies created by Amazon Web Services.
custom – Returns only the custom policies created in your Amazon Web Services account.
String marker
Use this field when paginating results to indicate where to begin in your list of origin request policies. The
response includes origin request policies in the list that occur after the marker. To get the next page of the
list, set this field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of origin request policies that you want in the response.
OriginRequestPolicyList originRequestPolicyList
A list of origin request policies.
String marker
Use this when paginating results to indicate where to begin in your list of public keys. The results include
public keys in the list that occur after the marker. To get the next page of results, set the Marker
to the value of the NextMarker from the current page's response (which is also the ID of the last
public key on that page).
String maxItems
The maximum number of public keys you want in the response body.
PublicKeyList publicKeyList
Returns a list of all public keys that have been added to CloudFront for this account.
String maxItems
The maximum number of real-time log configurations that you want in the response.
String marker
Use this field when paginating results to indicate where to begin in your list of real-time log configurations.
The response includes real-time log configurations in the list that occur after the marker. To get the next page
of the list, set this field’s value to the value of NextMarker from the current page’s response.
RealtimeLogConfigs realtimeLogConfigs
A list of real-time log configurations.
String type
A filter to get only the specified kind of response headers policies. Valid values are:
managed – Gets only the managed policies created by Amazon Web Services.
custom – Gets only the custom policies created in your Amazon Web Services account.
String marker
Use this field when paginating results to indicate where to begin in your list of response headers policies. The
response includes response headers policies in the list that occur after the marker. To get the next page of the
list, set this field’s value to the value of NextMarker from the current page’s response.
String maxItems
The maximum number of response headers policies that you want to get in the response.
ResponseHeadersPolicyList responseHeadersPolicyList
A list of response headers policies.
StreamingDistributionList streamingDistributionList
The StreamingDistributionList type.
String resource
An ARN of a CloudFront resource.
Tags tags
A complex type that contains zero or more Tag elements.
Boolean enabled
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.
Boolean includeCookies
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.
String bucket
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
String prefix
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.
RealtimeMetricsSubscriptionConfig realtimeMetricsSubscriptionConfig
A subscription configuration for additional CloudWatch metrics.
String id
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.
String domainName
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
String originPath
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide.
CustomHeaders customHeaders
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.
S3OriginConfig s3OriginConfig
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.
CustomOriginConfig customOriginConfig
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.
Integer connectionAttempts
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.
Integer connectionTimeout
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.
OriginShield originShield
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.
String originAccessControlId
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.
String id
The unique identifier of the origin access control.
OriginAccessControlConfig originAccessControlConfig
The origin access control.
String name
A name to identify the origin access control.
String description
A description of the origin access control.
String signingProtocol
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates)
requests. The only valid value is sigv4.
String signingBehavior
Specifies which requests CloudFront signs (adds authentication information to). Specify always for
the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header
from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for
all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then
CloudFront signs the origin request. If the viewer request contains the Authorization header, then
CloudFront doesn't sign the origin request and instead passes along the Authorization header from
the viewer request. WARNING: To pass along the Authorization header from the viewer request, you
must add the Authorization header to a cache
policy for all cache behaviors that use origins associated with this origin access control.
String originAccessControlOriginType
The type of origin that this origin access control is for. The only valid value is s3.
String marker
The value of the Marker field that was provided in the request.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value to
use in the Marker field of another request to continue listing origin access controls.
Integer maxItems
The maximum number of origin access controls requested.
Boolean isTruncated
If there are more items in the list than are in this response, this value is true.
Integer quantity
The number of origin access controls returned in the response.
SdkInternalList<T> items
Contains the origin access controls in the list.
String id
The unique identifier of the origin access control.
String description
A description of the origin access control.
String name
A unique name that identifies the origin access control.
String signingProtocol
The signing protocol of the origin access control. The signing protocol determines how CloudFront signs
(authenticates) requests. The only valid value is sigv4.
String signingBehavior
A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
never – CloudFront doesn't sign any origin requests.
always – CloudFront signs all origin requests, overwriting the Authorization header
from the viewer request if necessary.
no-override – If the viewer request doesn't contain the Authorization header,
CloudFront signs the origin request. If the viewer request contains the Authorization header,
CloudFront doesn't sign the origin request, but instead passes along the Authorization header that
it received in the viewer request.
String originAccessControlOriginType
The type of origin that this origin access control is for. The only valid value is s3.
String headerName
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.
String headerValue
The value for the header that you specified in the HeaderName field.
String id
The origin group's ID.
OriginGroupFailoverCriteria failoverCriteria
A complex type that contains information about the failover criteria for an origin group.
OriginGroupMembers members
A complex type that contains information about the origins in an origin group.
StatusCodes statusCodes
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
String originId
The ID for an origin in an origin group.
Integer quantity
The number of origins in an origin group.
SdkInternalList<T> items
Items (origins) in an origin group.
Integer quantity
The number of origin groups.
SdkInternalList<T> items
The items (origin groups) in a distribution.
String id
The unique identifier for the origin request policy.
Date lastModifiedTime
The date and time when the origin request policy was last modified.
OriginRequestPolicyConfig originRequestPolicyConfig
The origin request policy configuration.
String comment
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
String name
A unique name to identify the origin request policy.
OriginRequestPolicyHeadersConfig headersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
OriginRequestPolicyCookiesConfig cookiesConfig
The cookies from viewer requests to include in origin requests.
OriginRequestPolicyQueryStringsConfig queryStringsConfig
The URL query strings from viewer requests to include in origin requests.
String cookieBehavior
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin.
Even when this field is set to none, any cookies that are listed in a CachePolicy
are included in origin requests.
whitelist – The cookies in viewer requests that are listed in the CookieNames type are
included in requests that CloudFront sends to the origin.
all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
CookieNames cookies
String headerBehavior
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this
field is set to none, any headers that are listed in a CachePolicy are included
in origin requests.
whitelist – The HTTP headers that are listed in the Headers type are included in
requests that CloudFront sends to the origin.
allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to
the origin.
allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront
headers that are listed in the Headers type are included in requests that CloudFront sends to the
origin. The additional headers are added by CloudFront.
Headers headers
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing origin request
policies where you left off.
Integer maxItems
The maximum number of origin request policies requested.
Integer quantity
The total number of origin request policies returned in the response.
SdkInternalList<T> items
Contains the origin request policies in the list.
String queryStringBehavior
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the
origin. Even when this field is set to none, any query strings that are listed in a
CachePolicy are included in origin requests.
whitelist – The query strings in viewer requests that are listed in the
QueryStringNames type are included in requests that CloudFront sends to the origin.
all – All query strings in viewer requests are included in requests that CloudFront sends to the
origin.
QueryStringNames queryStrings
Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
String type
The type of origin request policy, either managed (created by Amazon Web Services) or
custom (created in this Amazon Web Services account).
OriginRequestPolicy originRequestPolicy
The origin request policy.
Integer quantity
The number of origins for this distribution.
SdkInternalList<T> items
A list of origins.
Boolean enabled
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.
String originShieldRegion
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.
Integer quantity
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
SdkInternalList<T> items
A list that contains allowed SSL/TLS protocols for this distribution.
Boolean enableAcceptEncodingGzip
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and
included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is
true and the viewer request includes the Accept-Encoding header, then CloudFront
does the following:
Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached,
do not include the Accept-Encoding header in the origin request policy. CloudFront always includes
the Accept-Encoding header in origin requests when the value of this field is true, so
including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header
the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s
not included in origin requests. In this case, you can manually add Accept-Encoding to the headers
whitelist like any other HTTP header.
Boolean enableAcceptEncodingBrotli
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and
included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is
true and the viewer request includes the Accept-Encoding header, then CloudFront
does the following:
Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached,
do not include the Accept-Encoding header in the origin request policy. CloudFront always includes
the Accept-Encoding header in origin requests when the value of this field is true, so
including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header
the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s
not included in origin requests. In this case, you can manually add Accept-Encoding to the headers
whitelist like any other HTTP header.
CachePolicyHeadersConfig headersConfig
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
CachePolicyCookiesConfig cookiesConfig
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
CachePolicyQueryStringsConfig queryStringsConfig
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 automatically included in requests that CloudFront sends to the origin.
Integer quantity
The number of invalidation paths specified for the objects that you want to invalidate.
SdkInternalList<T> items
A complex type that contains a list of the paths that you want to invalidate.
String id
The identifier of the public key.
Date createdTime
The date and time when the public key was uploaded.
PublicKeyConfig publicKeyConfig
Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
String callerReference
A string included in the request to help make sure that the request can’t be replayed.
String name
A name to help identify the public key.
String encodedKey
The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
String comment
A comment to describe the public key. The comment cannot be longer than 128 characters.
String nextMarker
If there are more elements to be listed, this element is present and contains the value that you can use for the
Marker request parameter to continue listing your public keys where you left off.
Integer maxItems
The maximum number of public keys you want in the response.
Integer quantity
The number of public keys in the list.
SdkInternalList<T> items
A list of public keys.
String id
The identifier of the public key.
String name
A name to help identify the public key.
Date createdTime
The date and time when the public key was uploaded.
String encodedKey
The public key.
String comment
A comment to describe the public key. The comment cannot be longer than 128 characters.
FunctionSummary functionSummary
Contains configuration information and metadata about a CloudFront function.
Boolean forwardWhenQueryArgProfileIsUnknown
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
QueryArgProfiles queryArgProfiles
Profiles specified for query argument-profile mapping for field-level encryption.
Integer quantity
Number of profiles for query argument-profile mapping for field-level encryption.
SdkInternalList<T> items
Number of items for query argument-profile mapping for field-level encryption.
Integer quantity
The number of whitelisted query string parameters for a cache behavior.
SdkInternalList<T> items
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.
Integer quantity
The number of query string names in the Items list.
SdkInternalList<T> items
A list of query string names.
String aRN
The Amazon Resource Name (ARN) of this real-time log configuration.
String name
The unique name of this real-time log configuration.
Long samplingRate
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
SdkInternalList<T> endPoints
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
SdkInternalList<T> fields
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
Integer maxItems
The maximum number of real-time log configurations requested.
SdkInternalList<T> items
Contains the list of real-time log configurations.
Boolean isTruncated
A flag that indicates whether there are more real-time log configurations than are contained in this list.
String marker
This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing real-time log
configurations where you left off.
String realtimeMetricsSubscriptionStatus
A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
String id
The identifier for the response headers policy.
Date lastModifiedTime
The date and time when the response headers policy was last modified.
ResponseHeadersPolicyConfig responseHeadersPolicyConfig
A response headers policy configuration.
A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.
Integer quantity
The number of HTTP header names in the list.
SdkInternalList<T> items
The list of HTTP header names. You can specify * to allow all headers.
Integer quantity
The number of HTTP methods in the list.
SdkInternalList<T> items
The list of HTTP methods. Valid values are:
GET
DELETE
HEAD
OPTIONS
PATCH
POST
PUT
ALL
ALL is a special value that includes all of the listed HTTP methods.
Integer quantity
The number of origins in the list.
SdkInternalList<T> items
The list of origins (domain names). You can specify * to allow all origins.
Integer quantity
The number of HTTP headers in the list.
SdkInternalList<T> items
The list of HTTP headers. You can specify * to expose all headers.
String comment
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
String name
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
ResponseHeadersPolicyCorsConfig corsConfig
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
ResponseHeadersPolicySecurityHeadersConfig securityHeadersConfig
A configuration for a set of security-related HTTP response headers.
ResponseHeadersPolicyServerTimingHeadersConfig serverTimingHeadersConfig
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
ResponseHeadersPolicyCustomHeadersConfig customHeadersConfig
A configuration for a set of custom HTTP response headers.
Boolean override
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response
header received from the origin with the one specified in this response headers policy.
String contentSecurityPolicy
The policy directives and their values that CloudFront includes as values for the
Content-Security-Policy HTTP response header.
Boolean override
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response
header received from the origin with the one specified in this response headers policy.
ResponseHeadersPolicyAccessControlAllowOrigins accessControlAllowOrigins
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.
ResponseHeadersPolicyAccessControlAllowHeaders accessControlAllowHeaders
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.
ResponseHeadersPolicyAccessControlAllowMethods accessControlAllowMethods
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.
Boolean accessControlAllowCredentials
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response
header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
ResponseHeadersPolicyAccessControlExposeHeaders accessControlExposeHeaders
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.
Integer accessControlMaxAgeSec
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
Boolean originOverride
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
Integer quantity
The number of HTTP response headers in the list.
SdkInternalList<T> items
The list of HTTP response headers and their values.
Boolean override
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header
received from the origin with the one specified in this response headers policy.
String frameOption
The value of the X-Frame-Options HTTP response header. Valid values are DENY and
SAMEORIGIN.
For more information about these values, see X-Frame-Options in the MDN Web Docs.
String nextMarker
If there are more items in the list than are in this response, this element is present. It contains the value
that you should use in the Marker field of a subsequent request to continue listing response headers
policies where you left off.
Integer maxItems
The maximum number of response headers policies requested.
Integer quantity
The number of response headers policies returned.
SdkInternalList<T> items
The response headers policies in the list.
Boolean override
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header
received from the origin with the one specified in this response headers policy.
String referrerPolicy
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrer
no-referrer-when-downgrade
origin
origin-when-cross-origin
same-origin
strict-origin
strict-origin-when-cross-origin
unsafe-url
For more information about these values, see Referrer-Policy in the MDN Web Docs.
ResponseHeadersPolicyXSSProtection 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.
ResponseHeadersPolicyFrameOptions frameOptions
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.
ResponseHeadersPolicyReferrerPolicy referrerPolicy
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.
ResponseHeadersPolicyContentSecurityPolicy contentSecurityPolicy
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.
ResponseHeadersPolicyContentTypeOptions contentTypeOptions
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its
value set to nosniff.
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
ResponseHeadersPolicyStrictTransportSecurity strictTransportSecurity
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.
Boolean enabled
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it
sends in response to requests that match a cache behavior that's associated with this response headers policy.
Double samplingRate
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the
Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the
Server-Timing header to the HTTP response for every request that matches the cache behavior that
this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the
responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up
to four decimal places.
Boolean override
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response
header received from the origin with the one specified in this response headers policy.
Boolean includeSubdomains
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the
Strict-Transport-Security HTTP response header.
Boolean preload
A Boolean that determines whether CloudFront includes the preload directive in the
Strict-Transport-Security HTTP response header.
Integer accessControlMaxAgeSec
A number that CloudFront uses as the value for the max-age directive in the
Strict-Transport-Security HTTP response header.
String type
The type of response headers policy, either managed (created by Amazon Web Services) or
custom (created in this Amazon Web Services account).
ResponseHeadersPolicy responseHeadersPolicy
The response headers policy.
Boolean override
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header
received from the origin with the one specified in this response headers policy.
Boolean protection
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting
is true, the value of the X-XSS-Protection header is 1. When this setting
is false, the value of the X-XSS-Protection header is 0.
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
Boolean modeBlock
A Boolean that determines whether CloudFront includes the mode=block directive in the
X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
String reportUri
A reporting URI, which CloudFront uses as the value of the report directive in the
X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true.
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
GeoRestriction 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.
String domainName
The DNS name of the Amazon S3 origin.
String originAccessIdentity
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.
If you want end users 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, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.
String originAccessIdentity
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where ID-of-origin-access-identity is the value that CloudFront returned in the
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.
String awsAccountNumber
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.
KeyPairIds keyPairIds
A list of CloudFront key pair identifiers.
Integer quantity
The number of status codes.
SdkInternalList<T> items
The items (status codes) for an origin group.
String id
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.
String aRN
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
your Amazon Web Services account ID.
String status
The current status of the RTMP distribution. When the status is Deployed, the distribution's
information is propagated to all CloudFront edge locations.
Date lastModifiedTime
The date and time that the distribution was last modified.
String domainName
The domain name that corresponds to the streaming distribution, for example,
s5c39gqb8ow64r.cloudfront.net.
ActiveTrustedSigners activeTrustedSigners
A complex type that lists the Amazon Web Services accounts, if any, that you included in the
TrustedSigners complex type for this distribution. These are the accounts that you want to allow to
create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or
self if the signer is the Amazon Web Services account that created the distribution. The
Signer element also includes the IDs of any active CloudFront key pairs that are associated with the
trusted signer's Amazon Web Services account. If no KeyPairId element appears for a
Signer, that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
StreamingDistributionConfig streamingDistributionConfig
The current configuration information for the RTMP distribution.
String callerReference
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
StreamingDistributionConfig 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.
S3Origin s3Origin
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
Aliases aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
String comment
Any comments you want to include about the streaming distribution.
StreamingLoggingConfig logging
A complex type that controls whether access logs are written for the streaming distribution.
TrustedSigners trustedSigners
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
String priceClass
A complex type that contains information about price class for this streaming distribution.
Boolean enabled
Whether the streaming distribution is enabled to accept user requests for content.
StreamingDistributionConfig streamingDistributionConfig
A streaming distribution Configuration.
Tags tags
A complex type that contains zero or more Tag elements.
String marker
The value you provided for the Marker request parameter.
String nextMarker
If IsTruncated is true, this element is present and contains the value you can use for
the Marker request parameter to continue listing your RTMP distributions where they left off.
Integer maxItems
The value you provided for the MaxItems request parameter.
Boolean isTruncated
A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated,
you can make a follow-up pagination request using the Marker request parameter to retrieve more
distributions in the list.
Integer quantity
The number of streaming distributions that were created by the current Amazon Web Services account.
SdkInternalList<T> items
A complex type that contains one StreamingDistributionSummary element for each distribution that was
created by the current Amazon Web Services account.
String id
The identifier for the distribution, for example, EDFDVBD632BHDS5.
String aRN
The ARN (Amazon Resource Name) for the streaming distribution. For example:
arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where
123456789012 is your Amazon Web Services account ID.
String status
Indicates the current status of the distribution. When the status is Deployed, the distribution's
information is fully propagated throughout the Amazon CloudFront system.
Date lastModifiedTime
The date and time the distribution was last modified.
String domainName
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
S3Origin s3Origin
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
Aliases aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
TrustedSigners trustedSigners
A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to create signed
URLs for private content. If you want to require signed URLs in requests for objects in the target origin that
match the PathPattern for this cache behavior, specify true for Enabled,
and specify the applicable values for Quantity and Items.If you don't want to require
signed URLs in requests for objects that match PathPattern, specify false for
Enabled and 0 for Quantity. Omit Items. To add, change, or
remove one or more trusted signers, change Enabled to true (if it's currently
false), change Quantity as applicable, and specify all of the trusted signers that you
want to include in the updated distribution.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
String comment
The comment originally specified when this distribution was created.
String priceClass
A complex type that contains information about price class for this streaming distribution.
Boolean enabled
Whether the distribution is enabled to accept end user requests for content.
Boolean enabled
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 streaming distribution or if you want to disable logging for an existing streaming
distribution, specify false for Enabled, and specify empty Bucket and
Prefix elements. If you specify false for Enabled but you specify values
for Bucket and Prefix, the values are automatically deleted.
String bucket
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
String prefix
An optional string that you want CloudFront to prefix to the access log filenames for this streaming
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.
String key
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z,
A-Z, 0-9, space, and the special characters _ - . : / = + @.
String value
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z,
A-Z, 0-9, space, and the special characters _ - . : / = + @.
SdkInternalList<T> items
A complex type that contains Tag key elements.
SdkInternalList<T> items
A complex type that contains Tag elements.
String name
The name of the function that you are testing.
String ifMatch
The current version (ETag value) of the function that you are testing, which you can get using
DescribeFunction.
String stage
The stage of the function that you are testing, either DEVELOPMENT or LIVE.
ByteBuffer eventObject
The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.
TestResult testResult
An object that represents the result of running the function with the provided event object.
FunctionSummary functionSummary
Contains configuration information and metadata about the CloudFront function that was tested.
String computeUtilization
The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.
SdkInternalList<T> functionExecutionLogs
Contains the log lines that the function wrote (if any) when running the test.
String functionErrorMessage
If the result of testing the function was an error, this field contains the error message.
String functionOutput
The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.
Boolean enabled
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.
Integer quantity
The number of key groups in the list.
SdkInternalList<T> items
A list of key groups identifiers.
Boolean enabled
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can
use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
Integer quantity
The number of Amazon Web Services accounts in the list.
SdkInternalList<T> items
A list of Amazon Web Services account identifiers.
CachePolicyConfig cachePolicyConfig
A cache policy configuration.
String id
The unique identifier for the cache policy that you are updating. The identifier is returned in a cache
behavior’s CachePolicyId field in the response to GetDistributionConfig.
String ifMatch
The version of the cache policy that you are updating. The version is returned in the cache policy’s
ETag field in the response to GetCachePolicyConfig.
CachePolicy cachePolicy
A cache policy.
String eTag
The current version of the cache policy.
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
The identity's configuration information.
String id
The identity's id.
String ifMatch
The value of the ETag header that you received when retrieving the identity's configuration. For
example: E2QWRUHAPOMQZL.
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
The origin access identity's information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
DistributionConfig distributionConfig
The distribution's configuration information.
String id
The distribution's id.
String ifMatch
The value of the ETag header that you received when retrieving the distribution's configuration. For
example: E2QWRUHAPOMQZL.
Distribution distribution
The distribution's information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
FieldLevelEncryptionConfig fieldLevelEncryptionConfig
Request to update a field-level encryption configuration.
String id
The ID of the configuration you want to update.
String ifMatch
The value of the ETag header that you received when retrieving the configuration identity to update.
For example: E2QWRUHAPOMQZL.
FieldLevelEncryption fieldLevelEncryption
Return the results of updating the configuration.
String eTag
The value of the ETag header that you received when updating the configuration. For example:
E2QWRUHAPOMQZL.
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig
Request to update a field-level encryption profile.
String id
The ID of the field-level encryption profile request.
String ifMatch
The value of the ETag header that you received when retrieving the profile identity to update. For
example: E2QWRUHAPOMQZL.
FieldLevelEncryptionProfile fieldLevelEncryptionProfile
Return the results of updating the profile.
String eTag
The result of the field-level encryption profile request.
String name
The name of the function that you are updating.
String ifMatch
The current version (ETag value) of the function that you are updating, which you can get using
DescribeFunction.
FunctionConfig functionConfig
Configuration information about the function.
ByteBuffer functionCode
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
FunctionSummary functionSummary
Contains configuration information and metadata about a CloudFront function.
String eTag
The version identifier for the current version of the CloudFront function.
KeyGroupConfig keyGroupConfig
The key group configuration.
String id
The identifier of the key group that you are updating.
String ifMatch
The version of the key group that you are updating. The version is the key group’s ETag value.
OriginAccessControlConfig originAccessControlConfig
An origin access control.
String id
The unique identifier of the origin access control that you are updating.
String ifMatch
The current version (ETag value) of the origin access control that you are updating.
OriginAccessControl originAccessControl
The origin access control after it has been updated.
String eTag
The new version of the origin access control after it has been updated.
OriginRequestPolicyConfig originRequestPolicyConfig
An origin request policy configuration.
String id
The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache
behavior’s OriginRequestPolicyId field in the response to GetDistributionConfig.
String ifMatch
The version of the origin request policy that you are updating. The version is returned in the origin request
policy’s ETag field in the response to GetOriginRequestPolicyConfig.
OriginRequestPolicy originRequestPolicy
An origin request policy.
String eTag
The current version of the origin request policy.
PublicKeyConfig publicKeyConfig
A public key configuration.
String id
The identifier of the public key that you are updating.
String ifMatch
The value of the ETag header that you received when retrieving the public key to update. For
example: E2QWRUHAPOMQZL.
SdkInternalList<T> endPoints
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
SdkInternalList<T> fields
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
String name
The name for this real-time log configuration.
String aRN
The Amazon Resource Name (ARN) for this real-time log configuration.
Long samplingRate
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
RealtimeLogConfig realtimeLogConfig
A real-time log configuration.
ResponseHeadersPolicyConfig responseHeadersPolicyConfig
A response headers policy configuration.
String id
The identifier for the response headers policy that you are updating.
String ifMatch
The version of the response headers policy that you are updating.
The version is returned in the cache policy’s ETag field in the response to
GetResponseHeadersPolicyConfig.
ResponseHeadersPolicy responseHeadersPolicy
A response headers policy.
String eTag
The current version of the response headers policy.
StreamingDistributionConfig streamingDistributionConfig
The streaming distribution's configuration information.
String id
The streaming distribution's id.
String ifMatch
The value of the ETag header that you received when retrieving the streaming distribution's
configuration. For example: E2QWRUHAPOMQZL.
StreamingDistribution streamingDistribution
The streaming distribution's information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
Boolean cloudFrontDefaultCertificate
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)
MinimumProtocolVersion
SSLSupportMethod
String iAMCertificateId
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.
String aCMCertificateArn
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.
String sSLSupportMethod
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.
String minimumProtocolVersion
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.
String certificate
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
String certificateSource
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
Copyright © 2022. All rights reserved.