Menu
Amazon CloudFront
API Reference (API Version 2017-03-25)

DistributionSummary

A summary of the information about a CloudFront distribution.

Contents

Aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

Type: Aliases object

Required: Yes

ARN

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

Type: String

Required: Yes

CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

Type: CacheBehaviors object

Required: Yes

Comment

The comment originally specified when this distribution was created.

Type: String

Required: Yes

CustomErrorResponses

A complex type that contains zero or more CustomErrorResponses elements.

Type: CustomErrorResponses object

Required: Yes

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.

Type: DefaultCacheBehavior object

Required: Yes

DomainName

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

Type: String

Required: Yes

Enabled

Whether the distribution is enabled to accept user requests for content.

Type: Boolean

Required: Yes

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.

Type: String

Valid Values: http1.1 | http2

Required: Yes

Id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

Type: String

Required: Yes

IsIPV6Enabled

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

Type: Boolean

Required: Yes

LastModifiedTime

The date and time the distribution was last modified.

Type: Timestamp

Required: Yes

Origins

A complex type that contains information about origins for this distribution.

Type: Origins object

Required: Yes

PriceClass

Type: String

Valid Values: PriceClass_100 | PriceClass_200 | PriceClass_All

Required: Yes

Restrictions

A complex type that identifies ways in which you want to restrict distribution of your content.

Type: Restrictions object

Required: Yes

Status

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

Type: String

Required: Yes

ViewerCertificate

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify only one of the following values:

Don't specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

Type: ViewerCertificate object

Required: Yes

WebACLId

The Web ACL Id (if any) associated with the distribution.

Type: String

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: