You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFront::Types::DistributionSummary

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A summary of the information about a CloudFront distribution.

Instance Attribute Summary collapse

Instance Attribute Details

#aliasesTypes::Aliases

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

Returns:

  • (Types::Aliases)

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

#arnString

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

Returns:

  • (String)

    The ARN (Amazon Resource Name) for the distribution.

#cache_behaviorsTypes::CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

Returns:

#commentString

The comment originally specified when this distribution was created.

Returns:

  • (String)

    The comment originally specified when this distribution was created.

#custom_error_responsesTypes::CustomErrorResponses

A complex type that contains zero or more CustomErrorResponses elements.

Returns:

#default_cache_behaviorTypes::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.

Returns:

  • (Types::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.

#domain_nameString

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

Returns:

  • (String)

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

#enabledBoolean

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

Returns:

  • (Boolean)

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

#http_versionString

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.

Possible values:

  • http1.1
  • http2

Returns:

  • (String)

    Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.

#idString

The identifier for the distribution. For example: EDFDVBD632BHDS5.

Returns:

  • (String)

    The identifier for the distribution.

#is_ipv6_enabledBoolean

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

Returns:

  • (Boolean)

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

#last_modified_timeTime

The date and time the distribution was last modified.

Returns:

  • (Time)

    The date and time the distribution was last modified.

#originsTypes::Origins

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

Returns:

  • (Types::Origins)

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

#price_classString

Possible values:

  • PriceClass_100
  • PriceClass_200
  • PriceClass_All

Returns:

  • (String)

#restrictionsTypes::Restrictions

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

Returns:

  • (Types::Restrictions)

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

    .

#statusString

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

Returns:

  • (String)

    The current status of the distribution.

#viewer_certificateTypes::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.

Returns:

  • (Types::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).

#web_acl_idString

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

Returns:

  • (String)

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