Boolean enabled
Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type
for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.
For more information, see ActiveTrustedSigners.
Integer quantity
A complex type that contains one Signer complex type for each trusted signer specified in the
TrustedSigners complex type.
For more information, see ActiveTrustedSigners.
SdkInternalList<T> items
A complex type that contains one Signer complex type for each trusted signer that is specified in
the TrustedSigners complex type.
For more information, see ActiveTrustedSigners.
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.
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 a request matches
the path pattern either for a cache behavior or for the default cache behavior in your distribution.
ForwardedValues forwardedValues
A complex type that specifies how CloudFront handles query strings and cookies.
TrustedSigners trustedSigners
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPattern for this cache behavior, specify true for Enabled, and specify
the applicable values for Quantity and Items. For more information, see Serving Private
Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
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.
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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
Long minTTL
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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).
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.
Long defaultTTL
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 Specifying How Long
Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer
Guide.
Long maxTTL
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 Specifying How Long
Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer
Guide.
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 function associations for 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 a cache behavior or for the default cache behavior in your distribution.
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 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
Any comments you want to include about the origin access identity.
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 AWS account.
SdkInternalList<T> items
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin
access identity that was created by the current AWS 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.
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 different cookies that you want CloudFront to forward to the origin for this cache behavior.
SdkInternalList<T> items
A complex type that contains one Name element for each cookie that you want CloudFront to forward to
the origin for this cache behavior.
String forward
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
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 Amazon CloudFront Limits in the AWS General Reference.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.
String eTag
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
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.
PublicKeyConfig publicKeyConfig
The request to add a public key to CloudFront.
PublicKey publicKey
Returned when you add a public key.
String location
The fully qualified URI of the new public key resource just created. For example:
https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.
String eTag
The current version of the public key. For example: E2QWRUHAPOMQZL.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
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. For example:
https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
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. If you don't want to specify a value, include an empty element,
<ResponsePagePath>, in the XML document.
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. If you don't want to specify a value, include an empty element,
<ResponseCode>, in the XML document.
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.
If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the
XML document.
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 the custom origin listens on.
Integer hTTPSPort
The HTTPS port the custom origin listens on.
String originProtocolPolicy
The origin protocol policy to apply to your origin.
OriginSslProtocols originSslProtocols
The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.
Integer originReadTimeout
You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.
If you need to increase the maximum time limit, contact the AWS Support Center.
Integer originKeepaliveTimeout
You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.
If you need to increase the maximum time limit, contact the AWS Support Center.
String targetOriginId
The value of ID for the origin that you want CloudFront to route requests to when a request matches
the path pattern either for a cache behavior or for the default cache behavior in your distribution.
ForwardedValues forwardedValues
A complex type that specifies how CloudFront handles query strings and cookies.
TrustedSigners trustedSigners
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPattern for this cache behavior, specify true for Enabled, and specify
the applicable values for Quantity and Items. For more information, see Serving Private
Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
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.
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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
Long minTTL
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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).
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.
Long defaultTTL
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 Specifying How Long
Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer
Guide.
Long maxTTL
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 function associations for 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 a cache behavior or for the default cache behavior in your distribution.
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 AWS 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
CloudFront automatically adds this element to the response only if you've set up the distribution to serve
private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted
signer. The Signer child element lists the AWS account number of the trusted signer (or an empty
Self element if the signer is you). The Signer element also includes the IDs of any
active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears
for a Signer, that signer can't create working signed URLs.
DistributionConfig distributionConfig
The current configuration information for the distribution. Send a GET request to the
/CloudFront API version/distribution ID/config resource.
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
Any comments you want to include about the distribution.
If you don't want to specify a comment, include an empty Comment element.
To delete an existing comment, update the distribution configuration and include an empty Comment
element.
To add or change a comment, update the distribution configuration and specify the new comment.
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. For price class information, scroll down to see the table at the bottom of the page.
Boolean enabled
From this field, you can enable or disable the selected distribution.
ViewerCertificate viewerCertificate
Restrictions restrictions
String webACLId
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.
String httpVersion
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
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 Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
You enable IPv6 for the distribution
You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.
If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
DistributionConfig distributionConfig
A 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 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 AWS account.
SdkInternalList<T> items
A complex type that contains one DistributionSummary element for each distribution that was created
by the current AWS 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 AWS 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
Restrictions restrictions
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.
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 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.
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.
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.
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.
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
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
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
A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for
this cache behavior.
QueryStringCacheKeys queryStringCacheKeys
A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
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 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.
DistributionConfig distributionConfig
The distribution's configuration information.
String eTag
The current version of the configuration. For example: E2QWRUHAPOMQZL.
String id
The distribution's ID.
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.
Invalidation invalidation
The invalidation's information. For more information, see Invalidation Complex Type.
String id
Request the ID for the public key configuration.
PublicKeyConfig publicKeyConfig
Return the result for the public key configuration.
String eTag
The current version of the public key configuration. For example: E2QWRUHAPOMQZL.
String id
Request the ID for the public key.
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 different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
Forward all headers to your origin: Specify 1 for Quantity and *
for Name.
CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base
caching on. Then specify the header names in Name elements. CloudFront caches your objects based on
the values in the specified headers.
Forward only the default headers: Specify 0 for Quantity and omit
Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
Custom origin: See HTTP Request Headers and CloudFront Behavior
SdkInternalList<T> items
A list that contains one Name element for each header that you want CloudFront to use for caching in
this cache behavior. If Quantity is 0, omit Items.
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 AWS account.
SdkInternalList<T> items
A complex type that contains one InvalidationSummary element for each invalidation batch created by
the current AWS account.
Integer quantity
The number of active CloudFront key pairs for AwsAccountNumber.
For more information, see ActiveTrustedSigners.
SdkInternalList<T> items
A complex type that lists the active CloudFront key pairs, if any, that are associated with
AwsAccountNumber.
For more information, see ActiveTrustedSigners.
String lambdaFunctionARN
The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.
String eventType
Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: The function executes when CloudFront receives a request from a viewer and before it
checks to see whether the requested object is in the edge cache.
origin-request: The function executes only when CloudFront forwards 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 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 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 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 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 AWS 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 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 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.
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.
String id
A unique identifier for the origin or origin group. The value of Id must be unique within the
distribution.
When you specify the value of TargetOriginId for the default cache behavior or for another cache
behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value
of the Id element for that origin. When a request matches the path pattern for that cache behavior,
CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
String domainName
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for
this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured
as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.
For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.
Constraints for Amazon S3 origins:
If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate
endpoint for DomainName.
The bucket name must be between 3 and 63 characters long (inclusive).
The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.
The bucket name must not contain adjacent periods.
Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for
this origin, for example, www.example.com.
Constraints for custom origins:
DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or
underscore (_) characters.
The name cannot exceed 128 characters.
String originPath
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or
your custom origin. When you include the OriginPath element, specify the directory name, beginning
with a /. CloudFront appends the directory name to the value of DomainName, for
example, example.com/production. Do not include a / at the end of the directory name.
For example, suppose you've specified the following values for your distribution:
DomainName: An Amazon S3 bucket named myawsbucket.
OriginPath: /production
CNAME: example.com
When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for
myawsbucket/production/index.html.
When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3
for myawsbucket/production/acme/index.html.
CustomHeaders customHeaders
A complex type that contains names and values for the custom headers that you want.
S3OriginConfig s3OriginConfig
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the
CustomOriginConfig element instead.
CustomOriginConfig customOriginConfig
A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the
S3OriginConfig element instead.
String headerName
The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon 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.
Integer quantity
The number of origins or origin groups for this distribution.
SdkInternalList<T> items
A complex type that contains origins or origin groups for this distribution.
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.
Integer quantity
The number of 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
A unique ID assigned to a public key you've added to CloudFront.
Date createdTime
A time you added a public key to CloudFront.
PublicKeyConfig publicKeyConfig
A complex data type for a public key you add to CloudFront to use with features like field-level encryption.
String callerReference
A unique number that ensures that the request can't be replayed.
String name
The name for a public key you add to CloudFront to use with features like field-level encryption.
String encodedKey
The encoded public key that you want to add to CloudFront to use with features like field-level encryption.
String comment
An optional comment about a public 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 public keys where you left off.
Integer maxItems
The maximum number of public keys you want in the response body.
Integer quantity
The number of public keys you added to CloudFront to use with features like field-level encryption.
SdkInternalList<T> items
An array of information about a public key you add to CloudFront to use with features like field-level encryption.
String id
ID for public key information summary.
String name
Name for public key information summary.
Date createdTime
Creation time for public key information summary.
String encodedKey
Encoded key for public key information summary.
String comment
Comment for public key information summary.
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 this cache behavior.
SdkInternalList<T> items
(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for
caching for this cache behavior. If Quantity is 0, you can omit Items.
GeoRestriction geoRestriction
String domainName
The DNS name of the Amazon S3 origin.
String originAccessIdentity
The CloudFront origin access identity to associate with the RTMP 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 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 AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid
values include:
self, which is the AWS account used to create the distribution.
An AWS account number.
KeyPairIds keyPairIds
A complex type that lists the active CloudFront key pairs, if any, that are associated with
AwsAccountNumber.
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 AWS 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 AWS 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 AWS account number of the trusted signer or self if
the signer is the AWS 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 AWS 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 AWS 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 AWS account.
SdkInternalList<T> items
A complex type that contains one StreamingDistributionSummary element for each distribution that was
created by the current AWS 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 AWS 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 AWS accounts, if any, that you want to allow to create signed URLs for private
content. If you want to require signed URLs in requests for objects in the target origin that match the
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.
String comment
The comment originally specified when this distribution was created.
String priceClass
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.
Boolean enabled
Specifies whether you want to require viewers to use signed URLs to access the files specified by
PathPattern and TargetOriginId.
Integer quantity
The number of trusted signers for this cache behavior.
SdkInternalList<T> items
Optional: A complex type that contains trusted signers for this cache behavior. If Quantity
is 0, you can omit Items.
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.
PublicKeyConfig publicKeyConfig
Request to update public key information.
String id
ID of the public key to be updated.
String ifMatch
The value of the ETag header that you received when retrieving the public key to update. For
example: E2QWRUHAPOMQZL.
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
For information about how and when to use CloudFrontDefaultCertificate, see
ViewerCertificate.
String iAMCertificateId
For information about how and when to use IAMCertificateId, see ViewerCertificate.
String aCMCertificateArn
For information about how and when to use ACMCertificateArn, see ViewerCertificate.
String sSLSupportMethod
If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:
vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from
any viewer. However, you will incur additional monthly charges.
sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication
(SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users'
browsers don't support SNI, we recommend that you do one of the following:
Use the vip option (dedicated IP addresses) instead of sni-only.
Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront
domain name of your distribution in the URLs for your objects, for example,
https://d111111abcdef8.cloudfront.net/logo.png.
If you can control which browser your users use, upgrade the browser to one that supports SNI.
Use HTTP instead of HTTPS.
Don't specify a value for SSLSupportMethod if you specified
<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.
For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
String minimumProtocolVersion
Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers
The cipher that CloudFront uses to encrypt the content that it returns to viewers
On the CloudFront console, this setting is called Security policy.
We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do
not support TLSv1.1 or later.
When both of the following are true, you must specify TLSv1 or later for the security policy:
You're using a custom certificate: you specified a value for ACMCertificateArn or for
IAMCertificateId
You're using SNI: you specified sni-only for SSLSupportMethod
If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the
security policy to TLSv1 regardless of the value that you specify for
MinimumProtocolVersion.
For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
String certificate
This field has been deprecated. Use one of the following fields instead:
String certificateSource
This field has been deprecated. Use one of the following fields instead:
Copyright © 2019. All rights reserved.