Interface DistributionConfig.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DistributionConfig.Builder,
,DistributionConfig> SdkBuilder<DistributionConfig.Builder,
,DistributionConfig> SdkPojo
- Enclosing class:
DistributionConfig
-
Method Summary
Modifier and TypeMethodDescriptiondefault DistributionConfig.Builder
aliases
(Consumer<Aliases.Builder> aliases) anycastIpListId
(String anycastIpListId) default DistributionConfig.Builder
cacheBehaviors
(Consumer<CacheBehaviors.Builder> cacheBehaviors) A complex type that contains zero or moreCacheBehavior
elements.cacheBehaviors
(CacheBehaviors cacheBehaviors) A complex type that contains zero or moreCacheBehavior
elements.callerReference
(String callerReference) A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.A comment to describe the distribution.connectionMode
(String connectionMode) This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).connectionMode
(ConnectionMode connectionMode) This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).continuousDeploymentPolicyId
(String continuousDeploymentPolicyId) default DistributionConfig.Builder
customErrorResponses
(Consumer<CustomErrorResponses.Builder> customErrorResponses) A complex type that controls the following:customErrorResponses
(CustomErrorResponses customErrorResponses) A complex type that controls the following:default DistributionConfig.Builder
defaultCacheBehavior
(Consumer<DefaultCacheBehavior.Builder> defaultCacheBehavior) A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements.defaultCacheBehavior
(DefaultCacheBehavior defaultCacheBehavior) A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements.defaultRootObject
(String defaultRootObject) When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin.From this field, you can enable or disable the selected distribution.httpVersion
(String httpVersion) (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront.httpVersion
(HttpVersion httpVersion) (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront.isIPV6Enabled
(Boolean isIPV6Enabled) default DistributionConfig.Builder
logging
(Consumer<LoggingConfig.Builder> logging) A complex type that controls whether access logs are written for the distribution.logging
(LoggingConfig logging) A complex type that controls whether access logs are written for the distribution.default DistributionConfig.Builder
originGroups
(Consumer<OriginGroups.Builder> originGroups) A complex type that contains information about origin groups for this distribution.originGroups
(OriginGroups originGroups) A complex type that contains information about origin groups for this distribution.default DistributionConfig.Builder
origins
(Consumer<Origins.Builder> origins) A complex type that contains information about origins for this distribution.A complex type that contains information about origins for this distribution.priceClass
(String priceClass) priceClass
(PriceClass priceClass) default DistributionConfig.Builder
restrictions
(Consumer<Restrictions.Builder> restrictions) A complex type that identifies ways in which you want to restrict distribution of your content.restrictions
(Restrictions restrictions) A complex type that identifies ways in which you want to restrict distribution of your content.default DistributionConfig.Builder
tenantConfig
(Consumer<TenantConfig.Builder> tenantConfig) tenantConfig
(TenantConfig tenantConfig) default DistributionConfig.Builder
viewerCertificate
(Consumer<ViewerCertificate.Builder> viewerCertificate) A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.viewerCertificate
(ViewerCertificate viewerCertificate) A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
callerReference
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 theDistributionConfig
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 aDistributionAlreadyExists
error.- Parameters:
callerReference
- 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 theDistributionConfig
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 aDistributionAlreadyExists
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aliases
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Parameters:
aliases
-This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aliases
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
This is a convenience method that creates an instance of theAliases.Builder
avoiding the need to create one manually viaAliases.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaliases(Aliases)
.- Parameters:
aliases
- a consumer that will call methods onAliases.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
defaultRootObject
When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is
https://www.example.com
, you can specify CloudFront to return theindex.html
file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example,https://www.example.com/product-description.html
). A default root object avoids exposing the contents of your distribution.You can specify the object name or a path to the object name (for example,
index.html
orexampleFolderName/index.html
). Your string can't begin with a forward slash (/
). Only specify the object name or the path to the object.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 Specify a default root object in the Amazon CloudFront Developer Guide.
- Parameters:
defaultRootObject
- When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL ishttps://www.example.com
, you can specify CloudFront to return theindex.html
file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example,https://www.example.com/product-description.html
). A default root object avoids exposing the contents of your distribution.You can specify the object name or a path to the object name (for example,
index.html
orexampleFolderName/index.html
). Your string can't begin with a forward slash (/
). Only specify the object name or the path to the object.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 Specify a default root object in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origins
A complex type that contains information about origins for this distribution.
- Parameters:
origins
- A complex type that contains information about origins for this distribution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origins
A complex type that contains information about origins for this distribution.
This is a convenience method that creates an instance of theOrigins.Builder
avoiding the need to create one manually viaOrigins.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toorigins(Origins)
.- Parameters:
origins
- a consumer that will call methods onOrigins.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
originGroups
A complex type that contains information about origin groups for this distribution.
- Parameters:
originGroups
- A complex type that contains information about origin groups for this distribution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originGroups
A complex type that contains information about origin groups for this distribution.
This is a convenience method that creates an instance of theOriginGroups.Builder
avoiding the need to create one manually viaOriginGroups.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooriginGroups(OriginGroups)
.- Parameters:
originGroups
- a consumer that will call methods onOriginGroups.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
defaultCacheBehavior
A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.- Parameters:
defaultCacheBehavior
- A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultCacheBehavior
default DistributionConfig.Builder defaultCacheBehavior(Consumer<DefaultCacheBehavior.Builder> defaultCacheBehavior) A complex type that describes the default cache behavior if you don't specify a
This is a convenience method that creates an instance of theCacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.DefaultCacheBehavior.Builder
avoiding the need to create one manually viaDefaultCacheBehavior.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultCacheBehavior(DefaultCacheBehavior)
.- Parameters:
defaultCacheBehavior
- a consumer that will call methods onDefaultCacheBehavior.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cacheBehaviors
A complex type that contains zero or more
CacheBehavior
elements.- Parameters:
cacheBehaviors
- A complex type that contains zero or moreCacheBehavior
elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheBehaviors
A complex type that contains zero or more
This is a convenience method that creates an instance of theCacheBehavior
elements.CacheBehaviors.Builder
avoiding the need to create one manually viaCacheBehaviors.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheBehaviors(CacheBehaviors)
.- Parameters:
cacheBehaviors
- a consumer that will call methods onCacheBehaviors.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
customErrorResponses
default DistributionConfig.Builder customErrorResponses(Consumer<CustomErrorResponses.Builder> 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.
This is a convenience method that creates an instance of theCustomErrorResponses.Builder
avoiding the need to create one manually viaCustomErrorResponses.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomErrorResponses(CustomErrorResponses)
.- Parameters:
customErrorResponses
- a consumer that will call methods onCustomErrorResponses.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
comment
A comment to describe the distribution. The comment cannot be longer than 128 characters.
- Parameters:
comment
- A comment to describe the distribution. The comment cannot be longer than 128 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logging
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.
- Parameters:
logging
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logging
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.
This is a convenience method that creates an instance of theLoggingConfig.Builder
avoiding the need to create one manually viaLoggingConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologging(LoggingConfig)
.- Parameters:
logging
- a consumer that will call methods onLoggingConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
priceClass
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
- Parameters:
priceClass
-This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
priceClass
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
- Parameters:
priceClass
-This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enabled
From this field, you can enable or disable the selected distribution.
- Parameters:
enabled
- From this field, you can enable or disable the selected distribution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
viewerCertificate
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- Parameters:
viewerCertificate
- A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
viewerCertificate
default DistributionConfig.Builder viewerCertificate(Consumer<ViewerCertificate.Builder> viewerCertificate) A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
This is a convenience method that creates an instance of theViewerCertificate.Builder
avoiding the need to create one manually viaViewerCertificate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toviewerCertificate(ViewerCertificate)
.- Parameters:
viewerCertificate
- a consumer that will call methods onViewerCertificate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
restrictions
A complex type that identifies ways in which you want to restrict distribution of your content.
- Parameters:
restrictions
- A complex type that identifies ways in which you want to restrict distribution of your content.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restrictions
A complex type that identifies ways in which you want to restrict distribution of your content.
This is a convenience method that creates an instance of theRestrictions.Builder
avoiding the need to create one manually viaRestrictions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestrictions(Restrictions)
.- Parameters:
restrictions
- a consumer that will call methods onRestrictions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
webACLId
Multi-tenant distributions only support WAF V2 web ACLs.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
. To specify a web ACL created using WAF Classic, use the ACL ID, for examplea1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.
- Parameters:
webACLId
-Multi-tenant distributions only support WAF V2 web ACLs.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
. To specify a web ACL created using WAF Classic, use the ACL ID, for examplea1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpVersion
(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is
http2
. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
- Parameters:
httpVersion
- (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions ishttp2
. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
httpVersion
(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is
http2
. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
- Parameters:
httpVersion
- (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions ishttp2
. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isIPV6Enabled
To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroupinvalid input: '<' /a>.
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
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.
- Parameters:
isIPV6Enabled
-To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
continuousDeploymentPolicyId
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
.- Parameters:
continuousDeploymentPolicyId
-This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
staging
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution.- Parameters:
staging
-This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
anycastIpListId
To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroupinvalid input: '<' /a>.
ID of the Anycast static IP list that is associated with the distribution.
- Parameters:
anycastIpListId
-To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.
ID of the Anycast static IP list that is associated with the distribution.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tenantConfig
This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A distribution tenant configuration.
- Parameters:
tenantConfig
-This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A distribution tenant configuration.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tenantConfig
This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A distribution tenant configuration.
This is a convenience method that creates an instance of theTenantConfig.Builder
avoiding the need to create one manually viaTenantConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totenantConfig(TenantConfig)
.- Parameters:
tenantConfig
- a consumer that will call methods onTenantConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
connectionMode
This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).
- Parameters:
connectionMode
- This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
connectionMode
This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).
- Parameters:
connectionMode
- This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-