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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFront::Types::DistributionSummary

Defined in:

gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb

Overview

A summary of the information about a CloudFront distribution.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:comment]

Instance Attribute Summary

• #alias_icp_recordals ⇒ Array<Types::AliasICPRecordal>

  Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront.

• #aliases ⇒ Types::Aliases

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

• #anycast_ip_list_id ⇒ String

  ID of the Anycast static IP list that is associated with the distribution.

• #arn ⇒ String

  The ARN (Amazon Resource Name) for the distribution.

• #cache_behaviors ⇒ Types::CacheBehaviors

  A complex type that contains zero or more CacheBehavior elements.

• #comment ⇒ String

  The comment originally specified when this distribution was created.

• #connection_mode ⇒ String

  This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

• #custom_error_responses ⇒ Types::CustomErrorResponses

  A complex type that contains zero or more CustomErrorResponses elements.

• #default_cache_behavior ⇒ 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_name ⇒ String

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

• #enabled ⇒ Boolean

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

• #etag ⇒ String

  The current version of the distribution.

• #http_version ⇒ String

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

• #id ⇒ String

  The identifier for the distribution.

• #is_ipv6_enabled ⇒ Boolean

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

• #last_modified_time ⇒ Time

  The date and time the distribution was last modified.

• #origin_groups ⇒ Types::OriginGroups

  A complex type that contains information about origin groups for this distribution.

• #origins ⇒ Types::Origins

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

• #price_class ⇒ String

  This field only supports standard distributions.

• #restrictions ⇒ Types::Restrictions

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

• #staging ⇒ Boolean

  A Boolean that indicates whether this is a staging distribution.

• #status ⇒ String

  The current status of the distribution.

• #viewer_certificate ⇒ Types::ViewerCertificate

  A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

• #web_acl_id ⇒ String

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

Instance Attribute Details

#alias_icp_recordals ⇒ Array<Types::AliasICPRecordal>

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

Returns:

• (Array<Types::AliasICPRecordal>)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#aliases ⇒ Types::Aliases

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

Returns:

• (Types::Aliases)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#anycast_ip_list_id ⇒ String

ID of the Anycast static IP list that is associated with the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#cache_behaviors ⇒ Types::CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

Returns:

• (Types::CacheBehaviors)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#comment ⇒ String

The comment originally specified when this distribution was created.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#connection_mode ⇒ String

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#custom_error_responses ⇒ Types::CustomErrorResponses

A complex type that contains zero or more CustomErrorResponses elements.

Returns:

• (Types::CustomErrorResponses)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#default_cache_behavior ⇒ 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. You must create exactly one default cache behavior.

Returns:

• (Types::DefaultCacheBehavior)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#domain_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#etag ⇒ String

The current version of the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#http_version ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#id ⇒ String

The identifier for the distribution. For example: EDFDVBD632BHDS5.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#is_ipv6_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#last_modified_time ⇒ Time

The date and time the distribution was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#origin_groups ⇒ Types::OriginGroups

A complex type that contains information about origin groups for this distribution.

Returns:

• (Types::OriginGroups)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#origins ⇒ Types::Origins

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

Returns:

• (Types::Origins)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#price_class ⇒ String

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A complex type that contains information about price class for this streaming distribution.

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#restrictions ⇒ Types::Restrictions

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

Returns:

• (Types::Restrictions)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#staging ⇒ Boolean

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#viewer_certificate ⇒ Types::ViewerCertificate

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

Returns:

• (Types::ViewerCertificate)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end

#web_acl_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5177

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :etag,
  :status,
  :last_modified_time,
  :domain_name,
  :aliases,
  :origins,
  :origin_groups,
  :default_cache_behavior,
  :cache_behaviors,
  :custom_error_responses,
  :comment,
  :price_class,
  :enabled,
  :viewer_certificate,
  :restrictions,
  :web_acl_id,
  :http_version,
  :is_ipv6_enabled,
  :alias_icp_recordals,
  :staging,
  :connection_mode,
  :anycast_ip_list_id)
  SENSITIVE = [:comment]
  include Aws::Structure
end