Class: Aws::CloudFront::Types::DistributionConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFront::Types::DistributionConfig
- Defined in:
- gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb
Overview
A distribution configuration.
Constant Summary collapse
- SENSITIVE =
[:comment]
Instance Attribute Summary collapse
-
#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.
-
#cache_behaviors ⇒ Types::CacheBehaviors
A complex type that contains zero or more
CacheBehavior
elements. -
#caller_reference ⇒ String
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
-
#comment ⇒ String
A comment to describe the distribution.
-
#continuous_deployment_policy_id ⇒ String
The identifier of a continuous deployment policy.
-
#custom_error_responses ⇒ Types::CustomErrorResponses
A complex type that controls the following:.
-
#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 ofPathPattern
inCacheBehavior
elements. -
#default_root_object ⇒ String
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 (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). -
#enabled ⇒ Boolean
From this field, you can enable or disable the selected distribution.
-
#http_version ⇒ String
(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront.
-
#is_ipv6_enabled ⇒ Boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. -
#logging ⇒ Types::LoggingConfig
A complex type that controls whether access logs are written for the distribution.
-
#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
The price class that corresponds with the maximum price that you want to pay for CloudFront service.
-
#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.
-
#viewer_certificate ⇒ Types::ViewerCertificate
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
-
#web_acl_id ⇒ String
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.
Instance Attribute Details
#aliases ⇒ Types::Aliases
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#cache_behaviors ⇒ Types::CacheBehaviors
A complex type that contains zero or more CacheBehavior
elements.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#caller_reference ⇒ String
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 the DistributionConfig
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 a
DistributionAlreadyExists
error.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#comment ⇒ String
A comment to describe the distribution. The comment cannot be longer than 128 characters.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#continuous_deployment_policy_id ⇒ String
The identifier of a continuous deployment policy. For more
information, see CreateContinuousDeploymentPolicy
.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#custom_error_responses ⇒ Types::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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#default_root_object ⇒ String
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 (https://www.example.com
) instead of an object in
your distribution
(https://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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#enabled ⇒ Boolean
From this field, you can enable or disable the selected distribution.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#http_version ⇒ String
(Optional) Specify the HTTP version(s) 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 TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#is_ipv6_enabled ⇒ Boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6
address for your distribution, specify true
. If you specify
false
, CloudFront responds to IPv6 DNS requests with the DNS
response code NOERROR
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 Route 53 Amazon Web Services 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 Route 53 Amazon Web Services Integration Developer Guide.
If you created a CNAME resource record set, either with Route 53 Amazon Web Services 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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#logging ⇒ Types::LoggingConfig
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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#origins ⇒ Types::Origins
A complex type that contains information about origins for this distribution.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#price_class ⇒ String
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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :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.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |
#web_acl_id ⇒ String
A unique identifier that specifies the WAF web ACL, if any, to
associate with this distribution. To specify a web ACL created using
the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.
To specify a web ACL created using WAF Classic, use the ACL ID, for
example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.
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 WAF, see the WAF Developer Guide.
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4060 class DistributionConfig < Struct.new( :caller_reference, :aliases, :default_root_object, :origins, :origin_groups, :default_cache_behavior, :cache_behaviors, :custom_error_responses, :comment, :logging, :price_class, :enabled, :viewer_certificate, :restrictions, :web_acl_id, :http_version, :is_ipv6_enabled, :continuous_deployment_policy_id, :staging, :anycast_ip_list_id) SENSITIVE = [:comment] include Aws::Structure end |