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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudfront/types.rb

Overview

A summary of the information about a CloudFront distribution.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alias_icp_recordals ⇒ Array<Types::AliasICPRecordal>

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.
#aliases ⇒ Types::Aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this 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.
#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.
#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

A complex type that contains information about price class for this streaming distribution.
#restrictions ⇒ Types::Restrictions

A complex type that identifies ways in which you want to restrict distribution of your content.
#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>`

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*.

[1]: docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html

Returns:

(Array<Types::AliasICPRecordal>)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 AWS account ID.

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_behaviors ⇒ `Types::CacheBehaviors`

A complex type that contains zero or more ‘CacheBehavior` elements.

Returns:

(Types::CacheBehaviors)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ `String`

The comment originally specified when this distribution was created.

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#custom_error_responses ⇒ `Types::CustomErrorResponses`

A complex type that contains zero or more ‘CustomErrorResponses` elements.

Returns:

(Types::CustomErrorResponses)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ `String`

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

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ `Boolean`

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

Returns:

(Boolean)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

The identifier for the distribution. For example: ‘EDFDVBD632BHDS5`.

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ `Time`

The date and time the distribution was last modified.

Returns:

(Time)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#origin_groups ⇒ `Types::OriginGroups`

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

Returns:

(Types::OriginGroups)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#origins ⇒ `Types::Origins`

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

Returns:

(Types::Origins)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#price_class ⇒ `String`

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

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  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 'lib/aws-sdk-cloudfront/types.rb', line 5266

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#web_acl_id ⇒ `String`

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

Returns:

(String)

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

class DistributionSummary < Struct.new(
  :id,
  :arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#alias_icp_recordals ⇒ Array<Types::AliasICPRecordal>

#aliases ⇒ Types::Aliases

#arn ⇒ String

#cache_behaviors ⇒ Types::CacheBehaviors

#comment ⇒ String

#custom_error_responses ⇒ Types::CustomErrorResponses

#default_cache_behavior ⇒ Types::DefaultCacheBehavior

#domain_name ⇒ String

#enabled ⇒ Boolean

#http_version ⇒ String

#id ⇒ String

#is_ipv6_enabled ⇒ Boolean

#last_modified_time ⇒ Time

#origin_groups ⇒ Types::OriginGroups

#origins ⇒ Types::Origins

#price_class ⇒ String

#restrictions ⇒ Types::Restrictions

#status ⇒ String

#viewer_certificate ⇒ Types::ViewerCertificate

#web_acl_id ⇒ String

#alias_icp_recordals ⇒ `Array<Types::AliasICPRecordal>`

#aliases ⇒ `Types::Aliases`

#arn ⇒ `String`

#cache_behaviors ⇒ `Types::CacheBehaviors`

#comment ⇒ `String`

#custom_error_responses ⇒ `Types::CustomErrorResponses`

#default_cache_behavior ⇒ `Types::DefaultCacheBehavior`

#domain_name ⇒ `String`

#enabled ⇒ `Boolean`

#http_version ⇒ `String`

#id ⇒ `String`

#is_ipv6_enabled ⇒ `Boolean`

#last_modified_time ⇒ `Time`

#origin_groups ⇒ `Types::OriginGroups`

#origins ⇒ `Types::Origins`

#price_class ⇒ `String`

#restrictions ⇒ `Types::Restrictions`

#status ⇒ `String`

#viewer_certificate ⇒ `Types::ViewerCertificate`

#web_acl_id ⇒ `String`