CreateDistribution
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you
want content to be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the
/CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
Request Syntax
POST /2020-05-31/distribution HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<DistributionConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
<Aliases>
<Items>
<CNAME>string
</CNAME>
</Items>
<Quantity>integer
</Quantity>
</Aliases>
<CacheBehaviors>
<Items>
<CacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string
</Method>
</Items>
<Quantity>integer
</Quantity>
</CachedMethods>
<Items>
<Method>string
</Method>
</Items>
<Quantity>integer
</Quantity>
</AllowedMethods>
<CachePolicyId>string
</CachePolicyId>
<Compress>boolean
</Compress>
<DefaultTTL>long
</DefaultTTL>
<FieldLevelEncryptionId>string
</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string
</Forward>
<WhitelistedNames>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</Headers>
<QueryString>boolean
</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string
</EventType>
<FunctionARN>string
</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer
</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string
</EventType>
<IncludeBody>boolean
</IncludeBody>
<LambdaFunctionARN>string
</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer
</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long
</MaxTTL>
<MinTTL>long
</MinTTL>
<OriginRequestPolicyId>string
</OriginRequestPolicyId>
<PathPattern>string
</PathPattern>
<RealtimeLogConfigArn>string
</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string
</ResponseHeadersPolicyId>
<SmoothStreaming>boolean
</SmoothStreaming>
<TargetOriginId>string
</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean
</Enabled>
<Items>
<KeyGroup>string
</KeyGroup>
</Items>
<Quantity>integer
</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean
</Enabled>
<Items>
<AwsAccountNumber>string
</AwsAccountNumber>
</Items>
<Quantity>integer
</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string
</ViewerProtocolPolicy>
</CacheBehavior>
</Items>
<Quantity>integer
</Quantity>
</CacheBehaviors>
<CallerReference>string
</CallerReference>
<Comment>string
</Comment>
<CustomErrorResponses>
<Items>
<CustomErrorResponse>
<ErrorCachingMinTTL>long
</ErrorCachingMinTTL>
<ErrorCode>integer
</ErrorCode>
<ResponseCode>string
</ResponseCode>
<ResponsePagePath>string
</ResponsePagePath>
</CustomErrorResponse>
</Items>
<Quantity>integer
</Quantity>
</CustomErrorResponses>
<DefaultCacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string
</Method>
</Items>
<Quantity>integer
</Quantity>
</CachedMethods>
<Items>
<Method>string
</Method>
</Items>
<Quantity>integer
</Quantity>
</AllowedMethods>
<CachePolicyId>string
</CachePolicyId>
<Compress>boolean
</Compress>
<DefaultTTL>long
</DefaultTTL>
<FieldLevelEncryptionId>string
</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string
</Forward>
<WhitelistedNames>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</Headers>
<QueryString>boolean
</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string
</Name>
</Items>
<Quantity>integer
</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string
</EventType>
<FunctionARN>string
</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer
</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string
</EventType>
<IncludeBody>boolean
</IncludeBody>
<LambdaFunctionARN>string
</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer
</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long
</MaxTTL>
<MinTTL>long
</MinTTL>
<OriginRequestPolicyId>string
</OriginRequestPolicyId>
<RealtimeLogConfigArn>string
</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string
</ResponseHeadersPolicyId>
<SmoothStreaming>boolean
</SmoothStreaming>
<TargetOriginId>string
</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean
</Enabled>
<Items>
<KeyGroup>string
</KeyGroup>
</Items>
<Quantity>integer
</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean
</Enabled>
<Items>
<AwsAccountNumber>string
</AwsAccountNumber>
</Items>
<Quantity>integer
</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string
</ViewerProtocolPolicy>
</DefaultCacheBehavior>
<DefaultRootObject>string
</DefaultRootObject>
<Enabled>boolean
</Enabled>
<HttpVersion>string
</HttpVersion>
<IsIPV6Enabled>boolean
</IsIPV6Enabled>
<Logging>
<Bucket>string
</Bucket>
<Enabled>boolean
</Enabled>
<IncludeCookies>boolean
</IncludeCookies>
<Prefix>string
</Prefix>
</Logging>
<OriginGroups>
<Items>
<OriginGroup>
<FailoverCriteria>
<StatusCodes>
<Items>
<StatusCode>integer
</StatusCode>
</Items>
<Quantity>integer
</Quantity>
</StatusCodes>
</FailoverCriteria>
<Id>string
</Id>
<Members>
<Items>
<OriginGroupMember>
<OriginId>string
</OriginId>
</OriginGroupMember>
</Items>
<Quantity>integer
</Quantity>
</Members>
</OriginGroup>
</Items>
<Quantity>integer
</Quantity>
</OriginGroups>
<Origins>
<Items>
<Origin>
<ConnectionAttempts>integer
</ConnectionAttempts>
<ConnectionTimeout>integer
</ConnectionTimeout>
<CustomHeaders>
<Items>
<OriginCustomHeader>
<HeaderName>string
</HeaderName>
<HeaderValue>string
</HeaderValue>
</OriginCustomHeader>
</Items>
<Quantity>integer
</Quantity>
</CustomHeaders>
<CustomOriginConfig>
<HTTPPort>integer
</HTTPPort>
<HTTPSPort>integer
</HTTPSPort>
<OriginKeepaliveTimeout>integer
</OriginKeepaliveTimeout>
<OriginProtocolPolicy>string
</OriginProtocolPolicy>
<OriginReadTimeout>integer
</OriginReadTimeout>
<OriginSslProtocols>
<Items>
<SslProtocol>string
</SslProtocol>
</Items>
<Quantity>integer
</Quantity>
</OriginSslProtocols>
</CustomOriginConfig>
<DomainName>string
</DomainName>
<Id>string
</Id>
<OriginPath>string
</OriginPath>
<OriginShield>
<Enabled>boolean
</Enabled>
<OriginShieldRegion>string
</OriginShieldRegion>
</OriginShield>
<S3OriginConfig>
<OriginAccessIdentity>string
</OriginAccessIdentity>
</S3OriginConfig>
</Origin>
</Items>
<Quantity>integer
</Quantity>
</Origins>
<PriceClass>string
</PriceClass>
<Restrictions>
<GeoRestriction>
<Items>
<Location>string
</Location>
</Items>
<Quantity>integer
</Quantity>
<RestrictionType>string
</RestrictionType>
</GeoRestriction>
</Restrictions>
<ViewerCertificate>
<ACMCertificateArn>string
</ACMCertificateArn>
<Certificate>string
</Certificate>
<CertificateSource>string
</CertificateSource>
<CloudFrontDefaultCertificate>boolean
</CloudFrontDefaultCertificate>
<IAMCertificateId>string
</IAMCertificateId>
<MinimumProtocolVersion>string
</MinimumProtocolVersion>
<SSLSupportMethod>string
</SSLSupportMethod>
</ViewerCertificate>
<WebACLId>string
</WebACLId>
</DistributionConfig>
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in XML format.
- DistributionConfig
-
Root level tag for the DistributionConfig parameters.
Required: Yes
- Aliases
-
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Type: Aliases object
Required: No
- CacheBehaviors
-
A complex type that contains zero or more
CacheBehavior
elements.Type: CacheBehaviors object
Required: No
- 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 theDistributionConfig
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 aDistributionAlreadyExists
error.Type: String
Required: Yes
- Comment
-
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
Type: String
Required: Yes
- 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.
Type: CustomErrorResponses object
Required: No
-
- 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 ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.Type: DefaultCacheBehavior object
Required: Yes
- 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.
Type: String
Required: No
- Enabled
-
From this field, you can enable or disable the selected distribution.
Type: Boolean
Required: Yes
- 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."
Type: String
Valid Values:
http1.1 | http2
Required: No
- IsIPV6Enabled
-
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
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 AWS 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 Amazon Route 53 AWS Integration Developer Guide.
If you created a CNAME resource record set, either with Amazon Route 53 AWS 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.
Type: Boolean
Required: No
-
- 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.
Type: LoggingConfig object
Required: No
- OriginGroups
-
A complex type that contains information about origin groups for this distribution.
Type: OriginGroups object
Required: No
- Origins
-
A complex type that contains information about origins for this distribution.
Type: Origins object
Required: Yes
- 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
. Type: String
Valid Values:
PriceClass_100 | PriceClass_200 | PriceClass_All
Required: No
- Restrictions
-
A complex type that identifies ways in which you want to restrict distribution of your content.
Type: Restrictions object
Required: No
- ViewerCertificate
-
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
Type: ViewerCertificate object
Required: No
- WebACLId
-
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
.AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.
Type: String
Required: No
Response Syntax
HTTP/1.1 201
<?xml version="1.0" encoding="UTF-8"?>
<Distribution>
<ActiveTrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>
<KeyGroupId>string</KeyGroupId>
<KeyPairIds>
<Items>
<KeyPairId>string</KeyPairId>
</Items>
<Quantity>integer</Quantity>
</KeyPairIds>
</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</ActiveTrustedKeyGroups>
<ActiveTrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<Signer>
<AwsAccountNumber>string</AwsAccountNumber>
<KeyPairIds>
<Items>
<KeyPairId>string</KeyPairId>
</Items>
<Quantity>integer</Quantity>
</KeyPairIds>
</Signer>
</Items>
<Quantity>integer</Quantity>
</ActiveTrustedSigners>
<AliasICPRecordals>
<AliasICPRecordal>
<CNAME>string</CNAME>
<ICPRecordalStatus>string</ICPRecordalStatus>
</AliasICPRecordal>
</AliasICPRecordals>
<ARN>string</ARN>
<DistributionConfig>
<Aliases>
<Items>
<CNAME>string</CNAME>
</Items>
<Quantity>integer</Quantity>
</Aliases>
<CacheBehaviors>
<Items>
<CacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</AllowedMethods>
<CachePolicyId>string</CachePolicyId>
<Compress>boolean</Compress>
<DefaultTTL>long</DefaultTTL>
<FieldLevelEncryptionId>string</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string</Forward>
<WhitelistedNames>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Headers>
<QueryString>boolean</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string</EventType>
<FunctionARN>string</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string</EventType>
<IncludeBody>boolean</IncludeBody>
<LambdaFunctionARN>string</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long</MaxTTL>
<MinTTL>long</MinTTL>
<OriginRequestPolicyId>string</OriginRequestPolicyId>
<PathPattern>string</PathPattern>
<RealtimeLogConfigArn>string</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
<SmoothStreaming>boolean</SmoothStreaming>
<TargetOriginId>string</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>string</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<AwsAccountNumber>string</AwsAccountNumber>
</Items>
<Quantity>integer</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string</ViewerProtocolPolicy>
</CacheBehavior>
</Items>
<Quantity>integer</Quantity>
</CacheBehaviors>
<CallerReference>string</CallerReference>
<Comment>string</Comment>
<CustomErrorResponses>
<Items>
<CustomErrorResponse>
<ErrorCachingMinTTL>long</ErrorCachingMinTTL>
<ErrorCode>integer</ErrorCode>
<ResponseCode>string</ResponseCode>
<ResponsePagePath>string</ResponsePagePath>
</CustomErrorResponse>
</Items>
<Quantity>integer</Quantity>
</CustomErrorResponses>
<DefaultCacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</AllowedMethods>
<CachePolicyId>string</CachePolicyId>
<Compress>boolean</Compress>
<DefaultTTL>long</DefaultTTL>
<FieldLevelEncryptionId>string</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string</Forward>
<WhitelistedNames>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Headers>
<QueryString>boolean</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string</EventType>
<FunctionARN>string</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string</EventType>
<IncludeBody>boolean</IncludeBody>
<LambdaFunctionARN>string</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long</MaxTTL>
<MinTTL>long</MinTTL>
<OriginRequestPolicyId>string</OriginRequestPolicyId>
<RealtimeLogConfigArn>string</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
<SmoothStreaming>boolean</SmoothStreaming>
<TargetOriginId>string</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>string</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<AwsAccountNumber>string</AwsAccountNumber>
</Items>
<Quantity>integer</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string</ViewerProtocolPolicy>
</DefaultCacheBehavior>
<DefaultRootObject>string</DefaultRootObject>
<Enabled>boolean</Enabled>
<HttpVersion>string</HttpVersion>
<IsIPV6Enabled>boolean</IsIPV6Enabled>
<Logging>
<Bucket>string</Bucket>
<Enabled>boolean</Enabled>
<IncludeCookies>boolean</IncludeCookies>
<Prefix>string</Prefix>
</Logging>
<OriginGroups>
<Items>
<OriginGroup>
<FailoverCriteria>
<StatusCodes>
<Items>
<StatusCode>integer</StatusCode>
</Items>
<Quantity>integer</Quantity>
</StatusCodes>
</FailoverCriteria>
<Id>string</Id>
<Members>
<Items>
<OriginGroupMember>
<OriginId>string</OriginId>
</OriginGroupMember>
</Items>
<Quantity>integer</Quantity>
</Members>
</OriginGroup>
</Items>
<Quantity>integer</Quantity>
</OriginGroups>
<Origins>
<Items>
<Origin>
<ConnectionAttempts>integer</ConnectionAttempts>
<ConnectionTimeout>integer</ConnectionTimeout>
<CustomHeaders>
<Items>
<OriginCustomHeader>
<HeaderName>string</HeaderName>
<HeaderValue>string</HeaderValue>
</OriginCustomHeader>
</Items>
<Quantity>integer</Quantity>
</CustomHeaders>
<CustomOriginConfig>
<HTTPPort>integer</HTTPPort>
<HTTPSPort>integer</HTTPSPort>
<OriginKeepaliveTimeout>integer</OriginKeepaliveTimeout>
<OriginProtocolPolicy>string</OriginProtocolPolicy>
<OriginReadTimeout>integer</OriginReadTimeout>
<OriginSslProtocols>
<Items>
<SslProtocol>string</SslProtocol>
</Items>
<Quantity>integer</Quantity>
</OriginSslProtocols>
</CustomOriginConfig>
<DomainName>string</DomainName>
<Id>string</Id>
<OriginPath>string</OriginPath>
<OriginShield>
<Enabled>boolean</Enabled>
<OriginShieldRegion>string</OriginShieldRegion>
</OriginShield>
<S3OriginConfig>
<OriginAccessIdentity>string</OriginAccessIdentity>
</S3OriginConfig>
</Origin>
</Items>
<Quantity>integer</Quantity>
</Origins>
<PriceClass>string</PriceClass>
<Restrictions>
<GeoRestriction>
<Items>
<Location>string</Location>
</Items>
<Quantity>integer</Quantity>
<RestrictionType>string</RestrictionType>
</GeoRestriction>
</Restrictions>
<ViewerCertificate>
<ACMCertificateArn>string</ACMCertificateArn>
<Certificate>string</Certificate>
<CertificateSource>string</CertificateSource>
<CloudFrontDefaultCertificate>boolean</CloudFrontDefaultCertificate>
<IAMCertificateId>string</IAMCertificateId>
<MinimumProtocolVersion>string</MinimumProtocolVersion>
<SSLSupportMethod>string</SSLSupportMethod>
</ViewerCertificate>
<WebACLId>string</WebACLId>
</DistributionConfig>
<DomainName>string</DomainName>
<Id>string</Id>
<InProgressInvalidationBatches>integer</InProgressInvalidationBatches>
<LastModifiedTime>timestamp</LastModifiedTime>
<Status>string</Status>
</Distribution>
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in XML format by the service.
- Distribution
-
Root level tag for the Distribution parameters.
Required: Yes
- 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.
Type: ActiveTrustedKeyGroups object
- ActiveTrustedSigners
-
Important We recommend using
TrustedKeyGroups
instead ofTrustedSigners
.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 AWS 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.
Type: ActiveTrustedSigners object
- AliasICPRecordals
-
AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials
in Getting Started with AWS services in China. Type: Array of AliasICPRecordal objects
- ARN
-
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where123456789012
is your AWS account ID.Type: String
- DistributionConfig
-
The current configuration information for the distribution. Send a
GET
request to the/CloudFront API version/distribution ID/config
resource.Type: DistributionConfig object
- DomainName
-
The domain name corresponding to the distribution, for example,
d111111abcdef8.cloudfront.net
.Type: String
- Id
-
The identifier for the distribution. For example:
EDFDVBD632BHDS5
.Type: String
- InProgressInvalidationBatches
-
The number of invalidation batches currently in progress.
Type: Integer
- LastModifiedTime
-
The date and time the distribution was last modified.
Type: Timestamp
- 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.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- CNAMEAlreadyExists
-
The CNAME specified is already defined for CloudFront.
HTTP Status Code: 409
- DistributionAlreadyExists
-
The caller reference you attempted to create the distribution with is associated with another distribution.
HTTP Status Code: 409
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior
-
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
HTTP Status Code: 400
- InconsistentQuantities
-
The value of
Quantity
and the size ofItems
don't match.HTTP Status Code: 400
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- InvalidDefaultRootObject
-
The default root object file name is too big or contains an invalid character.
HTTP Status Code: 400
- InvalidErrorCode
-
An invalid error code was specified.
HTTP Status Code: 400
- InvalidForwardCookies
-
Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.HTTP Status Code: 400
- InvalidFunctionAssociation
-
A CloudFront function association is invalid.
HTTP Status Code: 400
- InvalidGeoRestrictionParameter
-
The specified geo restriction parameter is not valid.
HTTP Status Code: 400
- InvalidHeadersForS3Origin
-
The headers specified are not valid for an Amazon S3 origin.
HTTP Status Code: 400
- InvalidLambdaFunctionAssociation
-
The specified Lambda@Edge function association is invalid.
HTTP Status Code: 400
- InvalidLocationCode
-
The location code specified is not valid.
HTTP Status Code: 400
- InvalidMinimumProtocolVersion
-
The minimum protocol version specified is not valid.
HTTP Status Code: 400
- InvalidOrigin
-
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
HTTP Status Code: 400
- InvalidOriginAccessIdentity
-
The origin access identity is not valid or doesn't exist.
HTTP Status Code: 400
- InvalidOriginKeepaliveTimeout
-
The keep alive timeout specified for the origin is not valid.
HTTP Status Code: 400
- InvalidOriginReadTimeout
-
The read timeout specified for the origin is not valid.
HTTP Status Code: 400
- InvalidProtocolSettings
-
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
HTTP Status Code: 400
- InvalidQueryStringParameters
-
The query string parameters specified are not valid.
HTTP Status Code: 400
- InvalidRelativePath
-
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
HTTP Status Code: 400
- InvalidRequiredProtocol
-
This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the
RequiredProtocols
element from your distribution configuration.HTTP Status Code: 400
- InvalidResponseCode
-
A response code is not valid.
HTTP Status Code: 400
- InvalidTTLOrder
-
The TTL order specified is not valid.
HTTP Status Code: 400
- InvalidViewerCertificate
-
A viewer certificate specified is not valid.
HTTP Status Code: 400
- InvalidWebACLId
-
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
.HTTP Status Code: 400
- MissingBody
-
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.HTTP Status Code: 400
- NoSuchCachePolicy
-
The cache policy does not exist.
HTTP Status Code: 404
- NoSuchFieldLevelEncryptionConfig
-
The specified configuration for field-level encryption doesn't exist.
HTTP Status Code: 404
- NoSuchOrigin
-
No origin exists with the specified
Origin Id
.HTTP Status Code: 404
- NoSuchOriginRequestPolicy
-
The origin request policy does not exist.
HTTP Status Code: 404
- NoSuchRealtimeLogConfig
-
The real-time log configuration does not exist.
HTTP Status Code: 404
- NoSuchResponseHeadersPolicy
-
The response headers policy does not exist.
HTTP Status Code: 404
- RealtimeLogConfigOwnerMismatch
-
The specified real-time log configuration belongs to a different AWS account.
HTTP Status Code: 401
- TooManyCacheBehaviors
-
You cannot create more cache behaviors for the distribution.
HTTP Status Code: 400
- TooManyCertificates
-
You cannot create anymore custom SSL/TLS certificates.
HTTP Status Code: 400
- TooManyCookieNamesInWhiteList
-
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
HTTP Status Code: 400
- TooManyDistributionCNAMEs
-
Your request contains more CNAMEs than are allowed per distribution.
HTTP Status Code: 400
- TooManyDistributions
-
Processing your request would cause you to exceed the maximum number of distributions allowed.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToCachePolicy
-
The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig
-
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToKeyGroup
-
The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToOriginRequestPolicy
-
The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToResponseHeadersPolicy
-
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsWithFunctionAssociations
-
You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsWithLambdaAssociations
-
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
HTTP Status Code: 400
- TooManyDistributionsWithSingleFunctionARN
-
The maximum number of distributions have been associated with the specified Lambda@Edge function.
HTTP Status Code: 400
- TooManyFunctionAssociations
-
You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyHeadersInForwardedValues
-
Your request contains too many headers in forwarded values.
HTTP Status Code: 400
- TooManyKeyGroupsAssociatedToDistribution
-
The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyLambdaFunctionAssociations
-
Your request contains more Lambda@Edge function associations than are allowed per distribution.
HTTP Status Code: 400
- TooManyOriginCustomHeaders
-
Your request contains too many origin custom headers.
HTTP Status Code: 400
- TooManyOriginGroupsPerDistribution
-
Processing your request would cause you to exceed the maximum number of origin groups allowed.
HTTP Status Code: 400
- TooManyOrigins
-
You cannot create more origins for the distribution.
HTTP Status Code: 400
- TooManyQueryStringParameters
-
Your request contains too many query string parameters.
HTTP Status Code: 400
- TooManyTrustedSigners
-
Your request contains more trusted signers than are allowed per distribution.
HTTP Status Code: 400
- TrustedKeyGroupDoesNotExist
-
The specified key group does not exist.
HTTP Status Code: 400
- TrustedSignerDoesNotExist
-
One or more of your trusted signers don't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: