Struct aws_sdk_cloudfront::model::DistributionConfig
source · #[non_exhaustive]pub struct DistributionConfig { /* private fields */ }Expand description
A distribution configuration.
Implementations§
source§impl 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(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.
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.
source§impl DistributionConfig
impl DistributionConfig
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DistributionConfig.
Examples found in repository?
7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298
pub fn deser_structure_crate_model_distribution_config(
decoder: &mut aws_smithy_xml::decode::ScopedDecoder,
) -> Result<crate::model::DistributionConfig, aws_smithy_xml::decode::XmlDecodeError> {
#[allow(unused_mut)]
let mut builder = crate::model::DistributionConfig::builder();
while let Some(mut tag) = decoder.next_tag() {
match tag.start_el() {
s if s.matches("CallerReference") /* CallerReference com.amazonaws.cloudfront#DistributionConfig$CallerReference */ => {
let var_207 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_caller_reference(var_207);
}
,
s if s.matches("Aliases") /* Aliases com.amazonaws.cloudfront#DistributionConfig$Aliases */ => {
let var_208 =
Some(
crate::xml_deser::deser_structure_crate_model_aliases(&mut tag)
?
)
;
builder = builder.set_aliases(var_208);
}
,
s if s.matches("DefaultRootObject") /* DefaultRootObject com.amazonaws.cloudfront#DistributionConfig$DefaultRootObject */ => {
let var_209 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_default_root_object(var_209);
}
,
s if s.matches("Origins") /* Origins com.amazonaws.cloudfront#DistributionConfig$Origins */ => {
let var_210 =
Some(
crate::xml_deser::deser_structure_crate_model_origins(&mut tag)
?
)
;
builder = builder.set_origins(var_210);
}
,
s if s.matches("OriginGroups") /* OriginGroups com.amazonaws.cloudfront#DistributionConfig$OriginGroups */ => {
let var_211 =
Some(
crate::xml_deser::deser_structure_crate_model_origin_groups(&mut tag)
?
)
;
builder = builder.set_origin_groups(var_211);
}
,
s if s.matches("DefaultCacheBehavior") /* DefaultCacheBehavior com.amazonaws.cloudfront#DistributionConfig$DefaultCacheBehavior */ => {
let var_212 =
Some(
crate::xml_deser::deser_structure_crate_model_default_cache_behavior(&mut tag)
?
)
;
builder = builder.set_default_cache_behavior(var_212);
}
,
s if s.matches("CacheBehaviors") /* CacheBehaviors com.amazonaws.cloudfront#DistributionConfig$CacheBehaviors */ => {
let var_213 =
Some(
crate::xml_deser::deser_structure_crate_model_cache_behaviors(&mut tag)
?
)
;
builder = builder.set_cache_behaviors(var_213);
}
,
s if s.matches("CustomErrorResponses") /* CustomErrorResponses com.amazonaws.cloudfront#DistributionConfig$CustomErrorResponses */ => {
let var_214 =
Some(
crate::xml_deser::deser_structure_crate_model_custom_error_responses(&mut tag)
?
)
;
builder = builder.set_custom_error_responses(var_214);
}
,
s if s.matches("Comment") /* Comment com.amazonaws.cloudfront#DistributionConfig$Comment */ => {
let var_215 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_comment(var_215);
}
,
s if s.matches("Logging") /* Logging com.amazonaws.cloudfront#DistributionConfig$Logging */ => {
let var_216 =
Some(
crate::xml_deser::deser_structure_crate_model_logging_config(&mut tag)
?
)
;
builder = builder.set_logging(var_216);
}
,
s if s.matches("PriceClass") /* PriceClass com.amazonaws.cloudfront#DistributionConfig$PriceClass */ => {
let var_217 =
Some(
Result::<crate::model::PriceClass, aws_smithy_xml::decode::XmlDecodeError>::Ok(
crate::model::PriceClass::from(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
)
?
)
;
builder = builder.set_price_class(var_217);
}
,
s if s.matches("Enabled") /* Enabled com.amazonaws.cloudfront#DistributionConfig$Enabled */ => {
let var_218 =
Some(
{
<bool as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (boolean: `com.amazonaws.cloudfront#boolean`)"))
}
?
)
;
builder = builder.set_enabled(var_218);
}
,
s if s.matches("ViewerCertificate") /* ViewerCertificate com.amazonaws.cloudfront#DistributionConfig$ViewerCertificate */ => {
let var_219 =
Some(
crate::xml_deser::deser_structure_crate_model_viewer_certificate(&mut tag)
?
)
;
builder = builder.set_viewer_certificate(var_219);
}
,
s if s.matches("Restrictions") /* Restrictions com.amazonaws.cloudfront#DistributionConfig$Restrictions */ => {
let var_220 =
Some(
crate::xml_deser::deser_structure_crate_model_restrictions(&mut tag)
?
)
;
builder = builder.set_restrictions(var_220);
}
,
s if s.matches("WebACLId") /* WebACLId com.amazonaws.cloudfront#DistributionConfig$WebACLId */ => {
let var_221 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_web_acl_id(var_221);
}
,
s if s.matches("HttpVersion") /* HttpVersion com.amazonaws.cloudfront#DistributionConfig$HttpVersion */ => {
let var_222 =
Some(
Result::<crate::model::HttpVersion, aws_smithy_xml::decode::XmlDecodeError>::Ok(
crate::model::HttpVersion::from(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
)
?
)
;
builder = builder.set_http_version(var_222);
}
,
s if s.matches("IsIPV6Enabled") /* IsIPV6Enabled com.amazonaws.cloudfront#DistributionConfig$IsIPV6Enabled */ => {
let var_223 =
Some(
{
<bool as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (boolean: `com.amazonaws.cloudfront#boolean`)"))
}
?
)
;
builder = builder.set_is_ipv6_enabled(var_223);
}
,
_ => {}
}
}
Ok(builder.build())
}Trait Implementations§
source§impl Clone for DistributionConfig
impl Clone for DistributionConfig
source§fn clone(&self) -> DistributionConfig
fn clone(&self) -> DistributionConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more