public static interface CacheBehavior.Builder extends CopyableBuilder<CacheBehavior.Builder,CacheBehavior>
Modifier and Type | Method and Description |
---|---|
CacheBehavior.Builder |
allowedMethods(AllowedMethods allowedMethods)
Sets the value of the AllowedMethods property for this object.
|
default CacheBehavior.Builder |
allowedMethods(Consumer<AllowedMethods.Builder> allowedMethods)
Sets the value of the AllowedMethods property for this object.
|
CacheBehavior.Builder |
compress(Boolean compress)
Whether you want CloudFront to automatically compress certain files for this cache behavior.
|
CacheBehavior.Builder |
defaultTTL(Long defaultTTL)
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards
another request to your origin to determine whether the object has been updated.
|
default CacheBehavior.Builder |
forwardedValues(Consumer<ForwardedValues.Builder> forwardedValues)
A complex type that specifies how CloudFront handles query strings and cookies.
|
CacheBehavior.Builder |
forwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings and cookies.
|
default CacheBehavior.Builder |
lambdaFunctionAssociations(Consumer<LambdaFunctionAssociations.Builder> lambdaFunctionAssociations)
A complex type that contains zero or more Lambda function associations for a cache behavior.
|
CacheBehavior.Builder |
lambdaFunctionAssociations(LambdaFunctionAssociations lambdaFunctionAssociations)
A complex type that contains zero or more Lambda function associations for a cache behavior.
|
CacheBehavior.Builder |
maxTTL(Long maxTTL)
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards
another request to your origin to determine whether the object has been updated.
|
CacheBehavior.Builder |
minTTL(Long minTTL)
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards
another request to your origin to determine whether the object has been updated.
|
CacheBehavior.Builder |
pathPattern(String pathPattern)
The pattern (for example,
images/*.jpg ) that specifies which requests to apply the behavior to. |
CacheBehavior.Builder |
smoothStreaming(Boolean smoothStreaming)
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the
origin that is associated with this cache behavior.
|
CacheBehavior.Builder |
targetOriginId(String targetOriginId)
The value of
ID for the origin that you want CloudFront to route requests to when a request
matches the path pattern either for a cache behavior or for the default cache behavior. |
default CacheBehavior.Builder |
trustedSigners(Consumer<TrustedSigners.Builder> trustedSigners)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for
private content.
|
CacheBehavior.Builder |
trustedSigners(TrustedSigners trustedSigners)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for
private content.
|
CacheBehavior.Builder |
viewerProtocolPolicy(String viewerProtocolPolicy)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern in PathPattern . |
CacheBehavior.Builder |
viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern in PathPattern . |
copy
applyMutation, build
CacheBehavior.Builder pathPattern(String pathPattern)
The pattern (for example, images/*.jpg
) that specifies which requests to apply the behavior to.
When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in
which cache behaviors are listed in the distribution.
You can optionally include a slash (/
) at the beginning of the path pattern. For example,
/images/*.jpg
. CloudFront behavior is the same with or without the leading /
.
The path pattern for the default cache behavior is *
and cannot be changed. If the request for
an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the
default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
pathPattern
- The pattern (for example, images/*.jpg
) that specifies which requests to apply the
behavior to. When CloudFront receives a viewer request, the requested path is compared with path
patterns in the order in which cache behaviors are listed in the distribution.
You can optionally include a slash (/
) at the beginning of the path pattern. For example,
/images/*.jpg
. CloudFront behavior is the same with or without the leading /
.
The path pattern for the default cache behavior is *
and cannot be changed. If the
request for an object does not match the path pattern for any cache behaviors, CloudFront applies the
behavior in the default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
CacheBehavior.Builder targetOriginId(String targetOriginId)
The value of ID
for the origin that you want CloudFront to route requests to when a request
matches the path pattern either for a cache behavior or for the default cache behavior.
targetOriginId
- The value of ID
for the origin that you want CloudFront to route requests to when a
request matches the path pattern either for a cache behavior or for the default cache behavior.CacheBehavior.Builder forwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings and cookies.
forwardedValues
- A complex type that specifies how CloudFront handles query strings and cookies.default CacheBehavior.Builder forwardedValues(Consumer<ForwardedValues.Builder> forwardedValues)
A complex type that specifies how CloudFront handles query strings and cookies.
This is a convenience that creates an instance of theForwardedValues.Builder
avoiding the need to
create one manually via ForwardedValues.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to forwardedValues(ForwardedValues)
.forwardedValues
- a consumer that will call methods on ForwardedValues.Builder
forwardedValues(ForwardedValues)
CacheBehavior.Builder trustedSigners(TrustedSigners trustedSigners)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPattern
for this cache behavior, specify true
for Enabled
, and
specify the applicable values for Quantity
and Items
. For more information, see Serving Private
Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
If you don't want to require signed URLs in requests for objects that match PathPattern
, specify
false
for Enabled
and 0
for Quantity
. Omit
Items
.
To add, change, or remove one or more trusted signers, change Enabled
to true
(if
it's currently false
), change Quantity
as applicable, and specify all of the
trusted signers that you want to include in the updated distribution.
trustedSigners
- A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs
for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPattern
for this cache behavior, specify true
for Enabled
,
and specify the applicable values for Quantity
and Items
. For more
information, see Serving
Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
If you don't want to require signed URLs in requests for objects that match PathPattern
,
specify false
for Enabled
and 0
for Quantity
. Omit
Items
.
To add, change, or remove one or more trusted signers, change Enabled
to
true
(if it's currently false
), change Quantity
as applicable,
and specify all of the trusted signers that you want to include in the updated distribution.
default CacheBehavior.Builder trustedSigners(Consumer<TrustedSigners.Builder> trustedSigners)
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the
PathPattern
for this cache behavior, specify true
for Enabled
, and
specify the applicable values for Quantity
and Items
. For more information, see Serving Private
Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
If you don't want to require signed URLs in requests for objects that match PathPattern
, specify
false
for Enabled
and 0
for Quantity
. Omit
Items
.
To add, change, or remove one or more trusted signers, change Enabled
to true
(if
it's currently false
), change Quantity
as applicable, and specify all of the
trusted signers that you want to include in the updated distribution.
TrustedSigners.Builder
avoiding the need to
create one manually via TrustedSigners.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to trustedSigners(TrustedSigners)
.trustedSigners
- a consumer that will call methods on TrustedSigners.Builder
trustedSigners(TrustedSigners)
CacheBehavior.Builder viewerProtocolPolicy(String viewerProtocolPolicy)
The protocol that viewers can use to access the files in the origin specified by TargetOriginId
when a request matches the path pattern in PathPattern
. You can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.
redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code
of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request
using the new URL.
https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403
(Forbidden).
For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
viewerProtocolPolicy
- The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern in PathPattern
. You
can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.
redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status
code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the
request using the new URL.
https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of
403 (Forbidden).
For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
ViewerProtocolPolicy
,
ViewerProtocolPolicy
CacheBehavior.Builder viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
The protocol that viewers can use to access the files in the origin specified by TargetOriginId
when a request matches the path pattern in PathPattern
. You can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.
redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code
of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request
using the new URL.
https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403
(Forbidden).
For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
viewerProtocolPolicy
- The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern in PathPattern
. You
can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.
redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status
code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the
request using the new URL.
https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of
403 (Forbidden).
For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
ViewerProtocolPolicy
,
ViewerProtocolPolicy
CacheBehavior.Builder minTTL(Long minTTL)
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.
You must specify 0
for MinTTL
if you configure CloudFront to forward all headers to
your origin (under Headers
, if you specify 1
for Quantity
and
*
for Name
).
minTTL
- The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront
forwards another request to your origin to determine whether the object has been updated. For more
information, see Specifying
How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon
CloudFront Developer Guide.
You must specify 0
for MinTTL
if you configure CloudFront to forward all
headers to your origin (under Headers
, if you specify 1
for
Quantity
and *
for Name
).
CacheBehavior.Builder allowedMethods(AllowedMethods allowedMethods)
allowedMethods
- The new value for the AllowedMethods property for this object.default CacheBehavior.Builder allowedMethods(Consumer<AllowedMethods.Builder> allowedMethods)
AllowedMethods.Builder
avoiding the need to
create one manually via AllowedMethods.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to allowedMethods(AllowedMethods)
.allowedMethods
- a consumer that will call methods on AllowedMethods.Builder
allowedMethods(AllowedMethods)
CacheBehavior.Builder smoothStreaming(Boolean smoothStreaming)
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the
origin that is associated with this cache behavior. If so, specify true
; if not, specify
false
. If you specify true
for SmoothStreaming
, you can still
distribute other content using this cache behavior if the content matches the value of
PathPattern
.
smoothStreaming
- Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using
the origin that is associated with this cache behavior. If so, specify true
; if not,
specify false
. If you specify true
for SmoothStreaming
, you can
still distribute other content using this cache behavior if the content matches the value of
PathPattern
.CacheBehavior.Builder defaultTTL(Long defaultTTL)
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards
another request to your origin to determine whether the object has been updated. The value that you specify
applies only when your origin does not add HTTP headers such as Cache-Control max-age
,
Cache-Control s-maxage
, and Expires
to objects. For more information, see Specifying How Long
Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer
Guide.
defaultTTL
- The default amount of time that you want objects to stay in CloudFront caches before CloudFront
forwards another request to your origin to determine whether the object has been updated. The value
that you specify applies only when your origin does not add HTTP headers such as
Cache-Control max-age
, Cache-Control s-maxage
, and Expires
to
objects. For more information, see Specifying
How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon
CloudFront Developer Guide.CacheBehavior.Builder maxTTL(Long maxTTL)
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards
another request to your origin to determine whether the object has been updated. The value that you specify
applies only when your origin adds HTTP headers such as Cache-Control max-age
,
Cache-Control s-maxage
, and Expires
to objects. For more information, see Specifying How Long
Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer
Guide.
maxTTL
- The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront
forwards another request to your origin to determine whether the object has been updated. The value
that you specify applies only when your origin adds HTTP headers such as
Cache-Control max-age
, Cache-Control s-maxage
, and Expires
to
objects. For more information, see Specifying
How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon
CloudFront Developer Guide.CacheBehavior.Builder compress(Boolean compress)
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
compress
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so,
specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.CacheBehavior.Builder lambdaFunctionAssociations(LambdaFunctionAssociations lambdaFunctionAssociations)
A complex type that contains zero or more Lambda function associations for a cache behavior.
lambdaFunctionAssociations
- A complex type that contains zero or more Lambda function associations for a cache behavior.default CacheBehavior.Builder lambdaFunctionAssociations(Consumer<LambdaFunctionAssociations.Builder> lambdaFunctionAssociations)
A complex type that contains zero or more Lambda function associations for a cache behavior.
This is a convenience that creates an instance of theLambdaFunctionAssociations.Builder
avoiding the
need to create one manually via LambdaFunctionAssociations.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to lambdaFunctionAssociations(LambdaFunctionAssociations)
.lambdaFunctionAssociations
- a consumer that will call methods on LambdaFunctionAssociations.Builder
lambdaFunctionAssociations(LambdaFunctionAssociations)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.