Struct aws_sdk_cloudfront::model::DistributionConfig
source · [−]#[non_exhaustive]pub struct DistributionConfig {Show 17 fields
pub caller_reference: Option<String>,
pub aliases: Option<Aliases>,
pub default_root_object: Option<String>,
pub origins: Option<Origins>,
pub origin_groups: Option<OriginGroups>,
pub default_cache_behavior: Option<DefaultCacheBehavior>,
pub cache_behaviors: Option<CacheBehaviors>,
pub custom_error_responses: Option<CustomErrorResponses>,
pub comment: Option<String>,
pub logging: Option<LoggingConfig>,
pub price_class: Option<PriceClass>,
pub enabled: Option<bool>,
pub viewer_certificate: Option<ViewerCertificate>,
pub restrictions: Option<Restrictions>,
pub web_acl_id: Option<String>,
pub http_version: Option<HttpVersion>,
pub is_ipv6_enabled: Option<bool>,
}
Expand description
A distribution configuration.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.caller_reference: Option<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.
aliases: Option<Aliases>
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
default_root_object: Option<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 (http://www.example.com
) instead of an object in your distribution (http://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.
origins: Option<Origins>
A complex type that contains information about origins for this distribution.
origin_groups: Option<OriginGroups>
A complex type that contains information about origin groups for this distribution.
default_cache_behavior: Option<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.
cache_behaviors: Option<CacheBehaviors>
A complex type that contains zero or more CacheBehavior
elements.
custom_error_responses: Option<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.
comment: Option<String>
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
logging: Option<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.
price_class: Option<PriceClass>
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.
enabled: Option<bool>
From this field, you can enable or disable the selected distribution.
viewer_certificate: Option<ViewerCertificate>
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
restrictions: Option<Restrictions>
A complex type that identifies ways in which you want to restrict distribution of your content.
web_acl_id: Option<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/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a
.
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.
http_version: Option<HttpVersion>
(Optional) 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 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
is_ipv6_enabled: Option<bool>
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.
Implementations
sourceimpl DistributionConfig
impl DistributionConfig
sourcepub fn caller_reference(&self) -> Option<&str>
pub fn caller_reference(&self) -> Option<&str>
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.
sourcepub fn aliases(&self) -> Option<&Aliases>
pub fn aliases(&self) -> Option<&Aliases>
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
sourcepub fn default_root_object(&self) -> Option<&str>
pub fn default_root_object(&self) -> Option<&str>
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 (http://www.example.com
) instead of an object in your distribution (http://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.
sourcepub fn origins(&self) -> Option<&Origins>
pub fn origins(&self) -> Option<&Origins>
A complex type that contains information about origins for this distribution.
sourcepub fn origin_groups(&self) -> Option<&OriginGroups>
pub fn origin_groups(&self) -> Option<&OriginGroups>
A complex type that contains information about origin groups for this distribution.
sourcepub fn default_cache_behavior(&self) -> Option<&DefaultCacheBehavior>
pub fn default_cache_behavior(&self) -> Option<&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.
sourcepub fn cache_behaviors(&self) -> Option<&CacheBehaviors>
pub fn cache_behaviors(&self) -> Option<&CacheBehaviors>
A complex type that contains zero or more CacheBehavior
elements.
sourcepub fn custom_error_responses(&self) -> Option<&CustomErrorResponses>
pub fn custom_error_responses(&self) -> Option<&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.
sourcepub fn comment(&self) -> Option<&str>
pub fn comment(&self) -> Option<&str>
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
sourcepub fn logging(&self) -> Option<&LoggingConfig>
pub fn logging(&self) -> Option<&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.
sourcepub fn price_class(&self) -> Option<&PriceClass>
pub fn price_class(&self) -> Option<&PriceClass>
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.
sourcepub fn enabled(&self) -> Option<bool>
pub fn enabled(&self) -> Option<bool>
From this field, you can enable or disable the selected distribution.
sourcepub fn viewer_certificate(&self) -> Option<&ViewerCertificate>
pub fn viewer_certificate(&self) -> Option<&ViewerCertificate>
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
sourcepub fn restrictions(&self) -> Option<&Restrictions>
pub fn restrictions(&self) -> Option<&Restrictions>
A complex type that identifies ways in which you want to restrict distribution of your content.
sourcepub fn web_acl_id(&self) -> Option<&str>
pub fn web_acl_id(&self) -> Option<&str>
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/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a
.
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.
sourcepub fn http_version(&self) -> Option<&HttpVersion>
pub fn http_version(&self) -> Option<&HttpVersion>
(Optional) 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 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
sourcepub fn is_ipv6_enabled(&self) -> Option<bool>
pub fn is_ipv6_enabled(&self) -> Option<bool>
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.
sourceimpl DistributionConfig
impl DistributionConfig
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DistributionConfig
Trait Implementations
sourceimpl Clone for DistributionConfig
impl Clone for DistributionConfig
sourcefn clone(&self) -> DistributionConfig
fn clone(&self) -> DistributionConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DistributionConfig
impl Debug for DistributionConfig
sourceimpl PartialEq<DistributionConfig> for DistributionConfig
impl PartialEq<DistributionConfig> for DistributionConfig
sourcefn eq(&self, other: &DistributionConfig) -> bool
fn eq(&self, other: &DistributionConfig) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DistributionConfig) -> bool
fn ne(&self, other: &DistributionConfig) -> bool
This method tests for !=
.
impl StructuralPartialEq for DistributionConfig
Auto Trait Implementations
impl RefUnwindSafe for DistributionConfig
impl Send for DistributionConfig
impl Sync for DistributionConfig
impl Unpin for DistributionConfig
impl UnwindSafe for DistributionConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more