AWS SDK for C++  1.9.47
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudFront::Model::DistributionConfig Class Reference

#include <DistributionConfig.h>

Public Member Functions

 DistributionConfig ()
 
 DistributionConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DistributionConfigoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetCallerReference () const
 
bool CallerReferenceHasBeenSet () const
 
void SetCallerReference (const Aws::String &value)
 
void SetCallerReference (Aws::String &&value)
 
void SetCallerReference (const char *value)
 
DistributionConfigWithCallerReference (const Aws::String &value)
 
DistributionConfigWithCallerReference (Aws::String &&value)
 
DistributionConfigWithCallerReference (const char *value)
 
const AliasesGetAliases () const
 
bool AliasesHasBeenSet () const
 
void SetAliases (const Aliases &value)
 
void SetAliases (Aliases &&value)
 
DistributionConfigWithAliases (const Aliases &value)
 
DistributionConfigWithAliases (Aliases &&value)
 
const Aws::StringGetDefaultRootObject () const
 
bool DefaultRootObjectHasBeenSet () const
 
void SetDefaultRootObject (const Aws::String &value)
 
void SetDefaultRootObject (Aws::String &&value)
 
void SetDefaultRootObject (const char *value)
 
DistributionConfigWithDefaultRootObject (const Aws::String &value)
 
DistributionConfigWithDefaultRootObject (Aws::String &&value)
 
DistributionConfigWithDefaultRootObject (const char *value)
 
const OriginsGetOrigins () const
 
bool OriginsHasBeenSet () const
 
void SetOrigins (const Origins &value)
 
void SetOrigins (Origins &&value)
 
DistributionConfigWithOrigins (const Origins &value)
 
DistributionConfigWithOrigins (Origins &&value)
 
const OriginGroupsGetOriginGroups () const
 
bool OriginGroupsHasBeenSet () const
 
void SetOriginGroups (const OriginGroups &value)
 
void SetOriginGroups (OriginGroups &&value)
 
DistributionConfigWithOriginGroups (const OriginGroups &value)
 
DistributionConfigWithOriginGroups (OriginGroups &&value)
 
const DefaultCacheBehaviorGetDefaultCacheBehavior () const
 
bool DefaultCacheBehaviorHasBeenSet () const
 
void SetDefaultCacheBehavior (const DefaultCacheBehavior &value)
 
void SetDefaultCacheBehavior (DefaultCacheBehavior &&value)
 
DistributionConfigWithDefaultCacheBehavior (const DefaultCacheBehavior &value)
 
DistributionConfigWithDefaultCacheBehavior (DefaultCacheBehavior &&value)
 
const CacheBehaviorsGetCacheBehaviors () const
 
bool CacheBehaviorsHasBeenSet () const
 
void SetCacheBehaviors (const CacheBehaviors &value)
 
void SetCacheBehaviors (CacheBehaviors &&value)
 
DistributionConfigWithCacheBehaviors (const CacheBehaviors &value)
 
DistributionConfigWithCacheBehaviors (CacheBehaviors &&value)
 
const CustomErrorResponsesGetCustomErrorResponses () const
 
bool CustomErrorResponsesHasBeenSet () const
 
void SetCustomErrorResponses (const CustomErrorResponses &value)
 
void SetCustomErrorResponses (CustomErrorResponses &&value)
 
DistributionConfigWithCustomErrorResponses (const CustomErrorResponses &value)
 
DistributionConfigWithCustomErrorResponses (CustomErrorResponses &&value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
DistributionConfigWithComment (const Aws::String &value)
 
DistributionConfigWithComment (Aws::String &&value)
 
DistributionConfigWithComment (const char *value)
 
const LoggingConfigGetLogging () const
 
bool LoggingHasBeenSet () const
 
void SetLogging (const LoggingConfig &value)
 
void SetLogging (LoggingConfig &&value)
 
DistributionConfigWithLogging (const LoggingConfig &value)
 
DistributionConfigWithLogging (LoggingConfig &&value)
 
const PriceClassGetPriceClass () const
 
bool PriceClassHasBeenSet () const
 
void SetPriceClass (const PriceClass &value)
 
void SetPriceClass (PriceClass &&value)
 
DistributionConfigWithPriceClass (const PriceClass &value)
 
DistributionConfigWithPriceClass (PriceClass &&value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
DistributionConfigWithEnabled (bool value)
 
const ViewerCertificateGetViewerCertificate () const
 
bool ViewerCertificateHasBeenSet () const
 
void SetViewerCertificate (const ViewerCertificate &value)
 
void SetViewerCertificate (ViewerCertificate &&value)
 
DistributionConfigWithViewerCertificate (const ViewerCertificate &value)
 
DistributionConfigWithViewerCertificate (ViewerCertificate &&value)
 
const RestrictionsGetRestrictions () const
 
bool RestrictionsHasBeenSet () const
 
void SetRestrictions (const Restrictions &value)
 
void SetRestrictions (Restrictions &&value)
 
DistributionConfigWithRestrictions (const Restrictions &value)
 
DistributionConfigWithRestrictions (Restrictions &&value)
 
const Aws::StringGetWebACLId () const
 
bool WebACLIdHasBeenSet () const
 
void SetWebACLId (const Aws::String &value)
 
void SetWebACLId (Aws::String &&value)
 
void SetWebACLId (const char *value)
 
DistributionConfigWithWebACLId (const Aws::String &value)
 
DistributionConfigWithWebACLId (Aws::String &&value)
 
DistributionConfigWithWebACLId (const char *value)
 
const HttpVersionGetHttpVersion () const
 
bool HttpVersionHasBeenSet () const
 
void SetHttpVersion (const HttpVersion &value)
 
void SetHttpVersion (HttpVersion &&value)
 
DistributionConfigWithHttpVersion (const HttpVersion &value)
 
DistributionConfigWithHttpVersion (HttpVersion &&value)
 
bool GetIsIPV6Enabled () const
 
bool IsIPV6EnabledHasBeenSet () const
 
void SetIsIPV6Enabled (bool value)
 
DistributionConfigWithIsIPV6Enabled (bool value)
 

Detailed Description

A distribution configuration.

See Also:

AWS API Reference

Definition at line 41 of file DistributionConfig.h.

Constructor & Destructor Documentation

◆ DistributionConfig() [1/2]

Aws::CloudFront::Model::DistributionConfig::DistributionConfig ( )

◆ DistributionConfig() [2/2]

Aws::CloudFront::Model::DistributionConfig::DistributionConfig ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::CloudFront::Model::DistributionConfig::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ AliasesHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::AliasesHasBeenSet ( ) const
inline

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

Definition at line 142 of file DistributionConfig.h.

◆ CacheBehaviorsHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::CacheBehaviorsHasBeenSet ( ) const
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 463 of file DistributionConfig.h.

◆ CallerReferenceHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::CallerReferenceHasBeenSet ( ) const
inline

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.

Definition at line 69 of file DistributionConfig.h.

◆ CommentHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::CommentHasBeenSet ( ) const
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 567 of file DistributionConfig.h.

◆ CustomErrorResponsesHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::CustomErrorResponsesHasBeenSet ( ) const
inline

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.

Definition at line 510 of file DistributionConfig.h.

◆ DefaultCacheBehaviorHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::DefaultCacheBehaviorHasBeenSet ( ) const
inline

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.

Definition at line 418 of file DistributionConfig.h.

◆ DefaultRootObjectHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::DefaultRootObjectHasBeenSet ( ) const
inline

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.

Definition at line 207 of file DistributionConfig.h.

◆ EnabledHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::EnabledHasBeenSet ( ) const
inline

From this field, you can enable or disable the selected distribution.

Definition at line 772 of file DistributionConfig.h.

◆ GetAliases()

const Aliases& Aws::CloudFront::Model::DistributionConfig::GetAliases ( ) const
inline

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

Definition at line 136 of file DistributionConfig.h.

◆ GetCacheBehaviors()

const CacheBehaviors& Aws::CloudFront::Model::DistributionConfig::GetCacheBehaviors ( ) const
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 457 of file DistributionConfig.h.

◆ GetCallerReference()

const Aws::String& Aws::CloudFront::Model::DistributionConfig::GetCallerReference ( ) const
inline

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.

Definition at line 59 of file DistributionConfig.h.

◆ GetComment()

const Aws::String& Aws::CloudFront::Model::DistributionConfig::GetComment ( ) const
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 561 of file DistributionConfig.h.

◆ GetCustomErrorResponses()

const CustomErrorResponses& Aws::CloudFront::Model::DistributionConfig::GetCustomErrorResponses ( ) const
inline

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.

Definition at line 499 of file DistributionConfig.h.

◆ GetDefaultCacheBehavior()

const DefaultCacheBehavior& Aws::CloudFront::Model::DistributionConfig::GetDefaultCacheBehavior ( ) const
inline

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.

Definition at line 410 of file DistributionConfig.h.

◆ GetDefaultRootObject()

const Aws::String& Aws::CloudFront::Model::DistributionConfig::GetDefaultRootObject ( ) const
inline

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.

Definition at line 187 of file DistributionConfig.h.

◆ GetEnabled()

bool Aws::CloudFront::Model::DistributionConfig::GetEnabled ( ) const
inline

From this field, you can enable or disable the selected distribution.

Definition at line 767 of file DistributionConfig.h.

◆ GetHttpVersion()

const HttpVersion& Aws::CloudFront::Model::DistributionConfig::GetHttpVersion ( ) const
inline

(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."

Definition at line 1022 of file DistributionConfig.h.

◆ GetIsIPV6Enabled()

bool Aws::CloudFront::Model::DistributionConfig::GetIsIPV6Enabled ( ) const
inline

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 Amazon Route 53 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 Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 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.

Definition at line 1114 of file DistributionConfig.h.

◆ GetLogging()

const LoggingConfig& Aws::CloudFront::Model::DistributionConfig::GetLogging ( ) const
inline

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.

Definition at line 612 of file DistributionConfig.h.

◆ GetOriginGroups()

const OriginGroups& Aws::CloudFront::Model::DistributionConfig::GetOriginGroups ( ) const
inline

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

Definition at line 371 of file DistributionConfig.h.

◆ GetOrigins()

const Origins& Aws::CloudFront::Model::DistributionConfig::GetOrigins ( ) const
inline

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

Definition at line 334 of file DistributionConfig.h.

◆ GetPriceClass()

const PriceClass& Aws::CloudFront::Model::DistributionConfig::GetPriceClass ( ) const
inline

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.

Definition at line 671 of file DistributionConfig.h.

◆ GetRestrictions()

const Restrictions& Aws::CloudFront::Model::DistributionConfig::GetRestrictions ( ) const
inline

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

Definition at line 826 of file DistributionConfig.h.

◆ GetViewerCertificate()

const ViewerCertificate& Aws::CloudFront::Model::DistributionConfig::GetViewerCertificate ( ) const
inline

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

Definition at line 789 of file DistributionConfig.h.

◆ GetWebACLId()

const Aws::String& Aws::CloudFront::Model::DistributionConfig::GetWebACLId ( ) const
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 876 of file DistributionConfig.h.

◆ HttpVersionHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::HttpVersionHasBeenSet ( ) const
inline

(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."

Definition at line 1034 of file DistributionConfig.h.

◆ IsIPV6EnabledHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::IsIPV6EnabledHasBeenSet ( ) const
inline

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 Amazon Route 53 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 Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 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.

Definition at line 1145 of file DistributionConfig.h.

◆ LoggingHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::LoggingHasBeenSet ( ) const
inline

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.

Definition at line 620 of file DistributionConfig.h.

◆ operator=()

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OriginGroupsHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::OriginGroupsHasBeenSet ( ) const
inline

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

Definition at line 377 of file DistributionConfig.h.

◆ OriginsHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::OriginsHasBeenSet ( ) const
inline

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

Definition at line 340 of file DistributionConfig.h.

◆ PriceClassHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::PriceClassHasBeenSet ( ) const
inline

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.

Definition at line 689 of file DistributionConfig.h.

◆ RestrictionsHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::RestrictionsHasBeenSet ( ) const
inline

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

Definition at line 832 of file DistributionConfig.h.

◆ SetAliases() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetAliases ( Aliases &&  value)
inline

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

Definition at line 154 of file DistributionConfig.h.

◆ SetAliases() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetAliases ( const Aliases value)
inline

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

Definition at line 148 of file DistributionConfig.h.

◆ SetCacheBehaviors() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetCacheBehaviors ( CacheBehaviors &&  value)
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 475 of file DistributionConfig.h.

◆ SetCacheBehaviors() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetCacheBehaviors ( const CacheBehaviors value)
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 469 of file DistributionConfig.h.

◆ SetCallerReference() [1/3]

void Aws::CloudFront::Model::DistributionConfig::SetCallerReference ( Aws::String &&  value)
inline

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.

Definition at line 89 of file DistributionConfig.h.

◆ SetCallerReference() [2/3]

void Aws::CloudFront::Model::DistributionConfig::SetCallerReference ( const Aws::String value)
inline

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.

Definition at line 79 of file DistributionConfig.h.

◆ SetCallerReference() [3/3]

void Aws::CloudFront::Model::DistributionConfig::SetCallerReference ( const char *  value)
inline

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.

Definition at line 99 of file DistributionConfig.h.

◆ SetComment() [1/3]

void Aws::CloudFront::Model::DistributionConfig::SetComment ( Aws::String &&  value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 579 of file DistributionConfig.h.

◆ SetComment() [2/3]

void Aws::CloudFront::Model::DistributionConfig::SetComment ( const Aws::String value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 573 of file DistributionConfig.h.

◆ SetComment() [3/3]

void Aws::CloudFront::Model::DistributionConfig::SetComment ( const char *  value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 585 of file DistributionConfig.h.

◆ SetCustomErrorResponses() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetCustomErrorResponses ( const CustomErrorResponses value)
inline

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.

Definition at line 521 of file DistributionConfig.h.

◆ SetCustomErrorResponses() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetCustomErrorResponses ( CustomErrorResponses &&  value)
inline

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.

Definition at line 532 of file DistributionConfig.h.

◆ SetDefaultCacheBehavior() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetDefaultCacheBehavior ( const DefaultCacheBehavior value)
inline

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.

Definition at line 426 of file DistributionConfig.h.

◆ SetDefaultCacheBehavior() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetDefaultCacheBehavior ( DefaultCacheBehavior &&  value)
inline

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.

Definition at line 434 of file DistributionConfig.h.

◆ SetDefaultRootObject() [1/3]

void Aws::CloudFront::Model::DistributionConfig::SetDefaultRootObject ( Aws::String &&  value)
inline

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.

Definition at line 247 of file DistributionConfig.h.

◆ SetDefaultRootObject() [2/3]

void Aws::CloudFront::Model::DistributionConfig::SetDefaultRootObject ( const Aws::String value)
inline

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.

Definition at line 227 of file DistributionConfig.h.

◆ SetDefaultRootObject() [3/3]

void Aws::CloudFront::Model::DistributionConfig::SetDefaultRootObject ( const char *  value)
inline

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.

Definition at line 267 of file DistributionConfig.h.

◆ SetEnabled()

void Aws::CloudFront::Model::DistributionConfig::SetEnabled ( bool  value)
inline

From this field, you can enable or disable the selected distribution.

Definition at line 777 of file DistributionConfig.h.

◆ SetHttpVersion() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetHttpVersion ( const HttpVersion value)
inline

(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."

Definition at line 1046 of file DistributionConfig.h.

◆ SetHttpVersion() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetHttpVersion ( HttpVersion &&  value)
inline

(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."

Definition at line 1058 of file DistributionConfig.h.

◆ SetIsIPV6Enabled()

void Aws::CloudFront::Model::DistributionConfig::SetIsIPV6Enabled ( bool  value)
inline

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 Amazon Route 53 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 Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 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.

Definition at line 1176 of file DistributionConfig.h.

◆ SetLogging() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetLogging ( const LoggingConfig value)
inline

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.

Definition at line 628 of file DistributionConfig.h.

◆ SetLogging() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetLogging ( LoggingConfig &&  value)
inline

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.

Definition at line 636 of file DistributionConfig.h.

◆ SetOriginGroups() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetOriginGroups ( const OriginGroups value)
inline

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

Definition at line 383 of file DistributionConfig.h.

◆ SetOriginGroups() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetOriginGroups ( OriginGroups &&  value)
inline

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

Definition at line 389 of file DistributionConfig.h.

◆ SetOrigins() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetOrigins ( const Origins value)
inline

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

Definition at line 346 of file DistributionConfig.h.

◆ SetOrigins() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetOrigins ( Origins &&  value)
inline

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

Definition at line 352 of file DistributionConfig.h.

◆ SetPriceClass() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetPriceClass ( const PriceClass value)
inline

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.

Definition at line 707 of file DistributionConfig.h.

◆ SetPriceClass() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetPriceClass ( PriceClass &&  value)
inline

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.

Definition at line 725 of file DistributionConfig.h.

◆ SetRestrictions() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetRestrictions ( const Restrictions value)
inline

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

Definition at line 838 of file DistributionConfig.h.

◆ SetRestrictions() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetRestrictions ( Restrictions &&  value)
inline

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

Definition at line 844 of file DistributionConfig.h.

◆ SetViewerCertificate() [1/2]

void Aws::CloudFront::Model::DistributionConfig::SetViewerCertificate ( const ViewerCertificate value)
inline

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

Definition at line 801 of file DistributionConfig.h.

◆ SetViewerCertificate() [2/2]

void Aws::CloudFront::Model::DistributionConfig::SetViewerCertificate ( ViewerCertificate &&  value)
inline

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

Definition at line 807 of file DistributionConfig.h.

◆ SetWebACLId() [1/3]

void Aws::CloudFront::Model::DistributionConfig::SetWebACLId ( Aws::String &&  value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 933 of file DistributionConfig.h.

◆ SetWebACLId() [2/3]

void Aws::CloudFront::Model::DistributionConfig::SetWebACLId ( const Aws::String value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 914 of file DistributionConfig.h.

◆ SetWebACLId() [3/3]

void Aws::CloudFront::Model::DistributionConfig::SetWebACLId ( const char *  value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 952 of file DistributionConfig.h.

◆ ViewerCertificateHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::ViewerCertificateHasBeenSet ( ) const
inline

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

Definition at line 795 of file DistributionConfig.h.

◆ WebACLIdHasBeenSet()

bool Aws::CloudFront::Model::DistributionConfig::WebACLIdHasBeenSet ( ) const
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 895 of file DistributionConfig.h.

◆ WithAliases() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithAliases ( Aliases &&  value)
inline

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

Definition at line 166 of file DistributionConfig.h.

◆ WithAliases() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithAliases ( const Aliases value)
inline

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

Definition at line 160 of file DistributionConfig.h.

◆ WithCacheBehaviors() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCacheBehaviors ( CacheBehaviors &&  value)
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 487 of file DistributionConfig.h.

◆ WithCacheBehaviors() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCacheBehaviors ( const CacheBehaviors value)
inline

A complex type that contains zero or more CacheBehavior elements.

Definition at line 481 of file DistributionConfig.h.

◆ WithCallerReference() [1/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCallerReference ( Aws::String &&  value)
inline

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.

Definition at line 119 of file DistributionConfig.h.

◆ WithCallerReference() [2/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCallerReference ( const Aws::String value)
inline

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.

Definition at line 109 of file DistributionConfig.h.

◆ WithCallerReference() [3/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCallerReference ( const char *  value)
inline

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.

Definition at line 129 of file DistributionConfig.h.

◆ WithComment() [1/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithComment ( Aws::String &&  value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 597 of file DistributionConfig.h.

◆ WithComment() [2/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithComment ( const Aws::String value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 591 of file DistributionConfig.h.

◆ WithComment() [3/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithComment ( const char *  value)
inline

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

Definition at line 603 of file DistributionConfig.h.

◆ WithCustomErrorResponses() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCustomErrorResponses ( const CustomErrorResponses value)
inline

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.

Definition at line 543 of file DistributionConfig.h.

◆ WithCustomErrorResponses() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithCustomErrorResponses ( CustomErrorResponses &&  value)
inline

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.

Definition at line 554 of file DistributionConfig.h.

◆ WithDefaultCacheBehavior() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithDefaultCacheBehavior ( const DefaultCacheBehavior value)
inline

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.

Definition at line 442 of file DistributionConfig.h.

◆ WithDefaultCacheBehavior() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithDefaultCacheBehavior ( DefaultCacheBehavior &&  value)
inline

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.

Definition at line 450 of file DistributionConfig.h.

◆ WithDefaultRootObject() [1/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithDefaultRootObject ( Aws::String &&  value)
inline

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.

Definition at line 307 of file DistributionConfig.h.

◆ WithDefaultRootObject() [2/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithDefaultRootObject ( const Aws::String value)
inline

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.

Definition at line 287 of file DistributionConfig.h.

◆ WithDefaultRootObject() [3/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithDefaultRootObject ( const char *  value)
inline

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.

Definition at line 327 of file DistributionConfig.h.

◆ WithEnabled()

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithEnabled ( bool  value)
inline

From this field, you can enable or disable the selected distribution.

Definition at line 782 of file DistributionConfig.h.

◆ WithHttpVersion() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithHttpVersion ( const HttpVersion value)
inline

(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."

Definition at line 1070 of file DistributionConfig.h.

◆ WithHttpVersion() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithHttpVersion ( HttpVersion &&  value)
inline

(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."

Definition at line 1082 of file DistributionConfig.h.

◆ WithIsIPV6Enabled()

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithIsIPV6Enabled ( bool  value)
inline

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 Amazon Route 53 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 Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 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.

Definition at line 1207 of file DistributionConfig.h.

◆ WithLogging() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithLogging ( const LoggingConfig value)
inline

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.

Definition at line 644 of file DistributionConfig.h.

◆ WithLogging() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithLogging ( LoggingConfig &&  value)
inline

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.

Definition at line 652 of file DistributionConfig.h.

◆ WithOriginGroups() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithOriginGroups ( const OriginGroups value)
inline

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

Definition at line 395 of file DistributionConfig.h.

◆ WithOriginGroups() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithOriginGroups ( OriginGroups &&  value)
inline

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

Definition at line 401 of file DistributionConfig.h.

◆ WithOrigins() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithOrigins ( const Origins value)
inline

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

Definition at line 358 of file DistributionConfig.h.

◆ WithOrigins() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithOrigins ( Origins &&  value)
inline

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

Definition at line 364 of file DistributionConfig.h.

◆ WithPriceClass() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithPriceClass ( const PriceClass value)
inline

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.

Definition at line 743 of file DistributionConfig.h.

◆ WithPriceClass() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithPriceClass ( PriceClass &&  value)
inline

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.

Definition at line 761 of file DistributionConfig.h.

◆ WithRestrictions() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithRestrictions ( const Restrictions value)
inline

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

Definition at line 850 of file DistributionConfig.h.

◆ WithRestrictions() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithRestrictions ( Restrictions &&  value)
inline

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

Definition at line 856 of file DistributionConfig.h.

◆ WithViewerCertificate() [1/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithViewerCertificate ( const ViewerCertificate value)
inline

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

Definition at line 813 of file DistributionConfig.h.

◆ WithViewerCertificate() [2/2]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithViewerCertificate ( ViewerCertificate &&  value)
inline

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

Definition at line 819 of file DistributionConfig.h.

◆ WithWebACLId() [1/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithWebACLId ( Aws::String &&  value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 990 of file DistributionConfig.h.

◆ WithWebACLId() [2/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithWebACLId ( const Aws::String value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 971 of file DistributionConfig.h.

◆ WithWebACLId() [3/3]

DistributionConfig& Aws::CloudFront::Model::DistributionConfig::WithWebACLId ( const char *  value)
inline

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS 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 AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

AWS 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 AWS WAF, see the AWS WAF Developer Guide.

Definition at line 1009 of file DistributionConfig.h.


The documentation for this class was generated from the following file: