public static interface DistributionConfig.Builder extends SdkPojo, CopyableBuilder<DistributionConfig.Builder,DistributionConfig>
Modifier and Type | Method and Description |
---|---|
DistributionConfig.Builder |
aliases(Aliases aliases)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this
distribution.
|
default DistributionConfig.Builder |
aliases(Consumer<Aliases.Builder> aliases)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this
distribution.
|
DistributionConfig.Builder |
cacheBehaviors(CacheBehaviors cacheBehaviors)
A complex type that contains zero or more
CacheBehavior elements. |
default DistributionConfig.Builder |
cacheBehaviors(Consumer<CacheBehaviors.Builder> cacheBehaviors)
A complex type that contains zero or more
CacheBehavior elements. |
DistributionConfig.Builder |
callerReference(String callerReference)
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
|
DistributionConfig.Builder |
comment(String comment)
Any comments you want to include about the distribution.
|
default DistributionConfig.Builder |
customErrorResponses(Consumer<CustomErrorResponses.Builder> customErrorResponses)
A complex type that controls the following:
|
DistributionConfig.Builder |
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 a
CacheBehavior
element or if files don't match any of the values of PathPattern in CacheBehavior
elements. |
DistributionConfig.Builder |
defaultCacheBehavior(DefaultCacheBehavior defaultCacheBehavior)
A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values of PathPattern in CacheBehavior
elements. |
DistributionConfig.Builder |
defaultRootObject(String defaultRootObject)
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 ). |
DistributionConfig.Builder |
enabled(Boolean enabled)
From this field, you can enable or disable the selected distribution.
|
DistributionConfig.Builder |
httpVersion(HttpVersion httpVersion)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.
|
DistributionConfig.Builder |
httpVersion(String httpVersion)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.
|
DistributionConfig.Builder |
isIPV6Enabled(Boolean isIPV6Enabled)
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true . |
default DistributionConfig.Builder |
logging(Consumer<LoggingConfig.Builder> logging)
A complex type that controls whether access logs are written for the distribution.
|
DistributionConfig.Builder |
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.
|
DistributionConfig.Builder |
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.
|
DistributionConfig.Builder |
origins(Origins origins)
A complex type that contains information about origins for this distribution.
|
DistributionConfig.Builder |
priceClass(PriceClass priceClass)
The price class that corresponds with the maximum price that you want to pay for CloudFront service.
|
DistributionConfig.Builder |
priceClass(String priceClass)
The price class that corresponds with the maximum price that you want to pay for CloudFront service.
|
default DistributionConfig.Builder |
restrictions(Consumer<Restrictions.Builder> restrictions)
This is a convenience that creates an instance of the
Restrictions.Builder avoiding the need to
create one manually via Restrictions.builder() . |
DistributionConfig.Builder |
restrictions(Restrictions restrictions)
|
default DistributionConfig.Builder |
viewerCertificate(Consumer<ViewerCertificate.Builder> viewerCertificate)
This is a convenience that creates an instance of the
ViewerCertificate.Builder avoiding the need to
create one manually via ViewerCertificate.builder() . |
DistributionConfig.Builder |
viewerCertificate(ViewerCertificate viewerCertificate)
|
DistributionConfig.Builder |
webACLId(String webACLId)
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.
|
copy
applyMutation, build
DistributionConfig.Builder callerReference(String 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 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.
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 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.
DistributionConfig.Builder aliases(Aliases aliases)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
aliases
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this
distribution.default DistributionConfig.Builder aliases(Consumer<Aliases.Builder> aliases)
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
This is a convenience that creates an instance of theAliases.Builder
avoiding the need to create one
manually via Aliases.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to aliases(Aliases)
.aliases
- a consumer that will call methods on Aliases.Builder
aliases(Aliases)
DistributionConfig.Builder defaultRootObject(String defaultRootObject)
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.
defaultRootObject
- 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.
DistributionConfig.Builder origins(Origins origins)
A complex type that contains information about origins for this distribution.
origins
- A complex type that contains information about origins for this distribution.default DistributionConfig.Builder origins(Consumer<Origins.Builder> origins)
A complex type that contains information about origins for this distribution.
This is a convenience that creates an instance of theOrigins.Builder
avoiding the need to create one
manually via Origins.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to origins(Origins)
.origins
- a consumer that will call methods on Origins.Builder
origins(Origins)
DistributionConfig.Builder originGroups(OriginGroups originGroups)
A complex type that contains information about origin groups for this distribution.
originGroups
- A complex type that contains information about origin groups for this distribution.default DistributionConfig.Builder originGroups(Consumer<OriginGroups.Builder> originGroups)
A complex type that contains information about origin groups for this distribution.
This is a convenience that creates an instance of theOriginGroups.Builder
avoiding the need to
create one manually via OriginGroups.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to originGroups(OriginGroups)
.originGroups
- a consumer that will call methods on OriginGroups.Builder
originGroups(OriginGroups)
DistributionConfig.Builder defaultCacheBehavior(DefaultCacheBehavior defaultCacheBehavior)
A complex type that describes the default cache behavior if you don't specify a CacheBehavior
element or if files don't match any of the values of PathPattern
in CacheBehavior
elements. You must create exactly one default cache behavior.
defaultCacheBehavior
- A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values of
PathPattern
in CacheBehavior
elements. You must create exactly one default
cache behavior.default DistributionConfig.Builder defaultCacheBehavior(Consumer<DefaultCacheBehavior.Builder> defaultCacheBehavior)
A complex type that describes the default cache behavior if you don't specify a CacheBehavior
element or if files don't match any of the values of PathPattern
in CacheBehavior
elements. You must create exactly one default cache behavior.
DefaultCacheBehavior.Builder
avoiding the need
to create one manually via DefaultCacheBehavior.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to defaultCacheBehavior(DefaultCacheBehavior)
.defaultCacheBehavior
- a consumer that will call methods on DefaultCacheBehavior.Builder
defaultCacheBehavior(DefaultCacheBehavior)
DistributionConfig.Builder cacheBehaviors(CacheBehaviors cacheBehaviors)
A complex type that contains zero or more CacheBehavior
elements.
cacheBehaviors
- A complex type that contains zero or more CacheBehavior
elements.default DistributionConfig.Builder cacheBehaviors(Consumer<CacheBehaviors.Builder> cacheBehaviors)
A complex type that contains zero or more CacheBehavior
elements.
CacheBehaviors.Builder
avoiding the need to
create one manually via CacheBehaviors.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to cacheBehaviors(CacheBehaviors)
.cacheBehaviors
- a consumer that will call methods on CacheBehaviors.Builder
cacheBehaviors(CacheBehaviors)
DistributionConfig.Builder customErrorResponses(CustomErrorResponses 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.
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.
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 that creates an instance of theCustomErrorResponses.Builder
avoiding the need
to create one manually via CustomErrorResponses.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to customErrorResponses(CustomErrorResponses)
.customErrorResponses
- a consumer that will call methods on CustomErrorResponses.Builder
customErrorResponses(CustomErrorResponses)
DistributionConfig.Builder comment(String comment)
Any comments you want to include about the distribution.
If you don't want to specify a comment, include an empty Comment
element.
To delete an existing comment, update the distribution configuration and include an empty
Comment
element.
To add or change a comment, update the distribution configuration and specify the new comment.
comment
- Any comments you want to include about the distribution.
If you don't want to specify a comment, include an empty Comment
element.
To delete an existing comment, update the distribution configuration and include an empty
Comment
element.
To add or change a comment, update the distribution configuration and specify the new comment.
DistributionConfig.Builder logging(LoggingConfig 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.
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.
default DistributionConfig.Builder logging(Consumer<LoggingConfig.Builder> 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 that creates an instance of theLoggingConfig.Builder
avoiding the need to
create one manually via LoggingConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to logging(LoggingConfig)
.logging
- a consumer that will call methods on LoggingConfig.Builder
logging(LoggingConfig)
DistributionConfig.Builder priceClass(String priceClass)
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you
specify PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront
edge locations.
If you specify a price class other than PriceClass_All
, CloudFront serves your objects from the
CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers
who are in or near regions that are excluded from your specified price class may encounter slower
performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.
priceClass
- The price class that corresponds with the maximum price that you want to pay for CloudFront service.
If you specify PriceClass_All
, CloudFront responds to requests for your objects from all
CloudFront edge locations.
If you specify a price class other than PriceClass_All
, CloudFront serves your objects
from the CloudFront edge location that has the lowest latency among the edge locations in your price
class. Viewers who are in or near regions that are excluded from your specified price class may
encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.
PriceClass
,
PriceClass
DistributionConfig.Builder priceClass(PriceClass priceClass)
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you
specify PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront
edge locations.
If you specify a price class other than PriceClass_All
, CloudFront serves your objects from the
CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers
who are in or near regions that are excluded from your specified price class may encounter slower
performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.
priceClass
- The price class that corresponds with the maximum price that you want to pay for CloudFront service.
If you specify PriceClass_All
, CloudFront responds to requests for your objects from all
CloudFront edge locations.
If you specify a price class other than PriceClass_All
, CloudFront serves your objects
from the CloudFront edge location that has the lowest latency among the edge locations in your price
class. Viewers who are in or near regions that are excluded from your specified price class may
encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.
PriceClass
,
PriceClass
DistributionConfig.Builder enabled(Boolean enabled)
From this field, you can enable or disable the selected distribution.
enabled
- From this field, you can enable or disable the selected distribution.DistributionConfig.Builder viewerCertificate(ViewerCertificate viewerCertificate)
viewerCertificate
- default DistributionConfig.Builder viewerCertificate(Consumer<ViewerCertificate.Builder> viewerCertificate)
ViewerCertificate.Builder
avoiding the need to
create one manually via ViewerCertificate.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to viewerCertificate(ViewerCertificate)
.viewerCertificate
- a consumer that will call methods on ViewerCertificate.Builder
viewerCertificate(ViewerCertificate)
DistributionConfig.Builder restrictions(Restrictions restrictions)
restrictions
- default DistributionConfig.Builder restrictions(Consumer<Restrictions.Builder> restrictions)
Restrictions.Builder
avoiding the need to
create one manually via Restrictions.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to restrictions(Restrictions)
.restrictions
- a consumer that will call methods on Restrictions.Builder
restrictions(Restrictions)
DistributionConfig.Builder webACLId(String webACLId)
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.
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.
webACLId
- A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this
distribution.
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.
DistributionConfig.Builder httpVersion(String httpVersion)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
httpVersion
- (Optional) Specify the maximum HTTP version that you want viewers to use to communicate with
CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2
automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
HttpVersion
,
HttpVersion
DistributionConfig.Builder httpVersion(HttpVersion httpVersion)
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
httpVersion
- (Optional) Specify the maximum HTTP version that you want viewers to use to communicate with
CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2
automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
HttpVersion
,
HttpVersion
DistributionConfig.Builder isIPV6Enabled(Boolean isIPV6Enabled)
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.
isIPV6Enabled
- 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.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.