public class CacheBehavior extends Object implements Serializable, Cloneable
Constructor and Description |
---|
CacheBehavior() |
Modifier and Type | Method and Description |
---|---|
CacheBehavior |
clone() |
boolean |
equals(Object obj) |
AllowedMethods |
getAllowedMethods() |
Boolean |
getCompress()
Whether you want CloudFront to automatically compress content for web
requests that include Accept-Encoding: gzip in the request header.
|
Long |
getDefaultTTL()
If you don't configure your origin to add a Cache-Control max-age
directive or an Expires header, DefaultTTL is the default amount of time
(in seconds) that an object is in a CloudFront cache before CloudFront
forwards another request to your origin to determine whether the object
has been updated.
|
ForwardedValues |
getForwardedValues()
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
Long |
getMaxTTL()
The maximum amount of time (in seconds) that an object is in a CloudFront
cache before CloudFront forwards another request to your origin to
determine whether the object has been updated.
|
Long |
getMinTTL()
The minimum amount of time that you want objects to stay in CloudFront
caches before CloudFront queries your origin to see whether the object
has been updated.You can specify a value from 0 to 3,153,600,000 seconds
(100 years).
|
String |
getPathPattern()
The pattern (for example, images/*.jpg) that specifies which requests you
want this cache behavior to apply to.
|
Boolean |
getSmoothStreaming()
Indicates whether you want to distribute media files in Microsoft Smooth
Streaming format using the origin that is associated with this cache
behavior.
|
String |
getTargetOriginId()
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.
|
TrustedSigners |
getTrustedSigners()
A complex type that specifies the AWS accounts, if any, that you want to
allow to create signed URLs for private content.
|
String |
getViewerProtocolPolicy()
Use this element to specify the protocol that users can use to access the
files in the origin specified by TargetOriginId when a request matches
the path pattern in PathPattern.
|
int |
hashCode() |
Boolean |
isCompress()
Whether you want CloudFront to automatically compress content for web
requests that include Accept-Encoding: gzip in the request header.
|
Boolean |
isSmoothStreaming()
Indicates whether you want to distribute media files in Microsoft Smooth
Streaming format using the origin that is associated with this cache
behavior.
|
void |
setAllowedMethods(AllowedMethods allowedMethods) |
void |
setCompress(Boolean compress)
Whether you want CloudFront to automatically compress content for web
requests that include Accept-Encoding: gzip in the request header.
|
void |
setDefaultTTL(Long defaultTTL)
If you don't configure your origin to add a Cache-Control max-age
directive or an Expires header, DefaultTTL is the default amount of time
(in seconds) that an object is in a CloudFront cache before CloudFront
forwards another request to your origin to determine whether the object
has been updated.
|
void |
setForwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
void |
setMaxTTL(Long maxTTL)
The maximum amount of time (in seconds) that an object is in a CloudFront
cache before CloudFront forwards another request to your origin to
determine whether the object has been updated.
|
void |
setMinTTL(Long minTTL)
The minimum amount of time that you want objects to stay in CloudFront
caches before CloudFront queries your origin to see whether the object
has been updated.You can specify a value from 0 to 3,153,600,000 seconds
(100 years).
|
void |
setPathPattern(String pathPattern)
The pattern (for example, images/*.jpg) that specifies which requests you
want this cache behavior to apply to.
|
void |
setSmoothStreaming(Boolean smoothStreaming)
Indicates whether you want to distribute media files in Microsoft Smooth
Streaming format using the origin that is associated with this cache
behavior.
|
void |
setTargetOriginId(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.
|
void |
setTrustedSigners(TrustedSigners trustedSigners)
A complex type that specifies the AWS accounts, if any, that you want to
allow to create signed URLs for private content.
|
void |
setViewerProtocolPolicy(String viewerProtocolPolicy)
Use this element to specify the protocol that users can use to access the
files in the origin specified by TargetOriginId when a request matches
the path pattern in PathPattern.
|
void |
setViewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
Use this element to specify the protocol that users can use to access the
files in the origin specified by TargetOriginId when a request matches
the path pattern in PathPattern.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CacheBehavior |
withAllowedMethods(AllowedMethods allowedMethods) |
CacheBehavior |
withCompress(Boolean compress)
Whether you want CloudFront to automatically compress content for web
requests that include Accept-Encoding: gzip in the request header.
|
CacheBehavior |
withDefaultTTL(Long defaultTTL)
If you don't configure your origin to add a Cache-Control max-age
directive or an Expires header, DefaultTTL is the default amount of time
(in seconds) that an object is in a CloudFront cache before CloudFront
forwards another request to your origin to determine whether the object
has been updated.
|
CacheBehavior |
withForwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
CacheBehavior |
withMaxTTL(Long maxTTL)
The maximum amount of time (in seconds) that an object is in a CloudFront
cache before CloudFront forwards another request to your origin to
determine whether the object has been updated.
|
CacheBehavior |
withMinTTL(Long minTTL)
The minimum amount of time that you want objects to stay in CloudFront
caches before CloudFront queries your origin to see whether the object
has been updated.You can specify a value from 0 to 3,153,600,000 seconds
(100 years).
|
CacheBehavior |
withPathPattern(String pathPattern)
The pattern (for example, images/*.jpg) that specifies which requests you
want this cache behavior to apply to.
|
CacheBehavior |
withSmoothStreaming(Boolean smoothStreaming)
Indicates whether you want to distribute media files in Microsoft Smooth
Streaming format using the origin that is associated with this cache
behavior.
|
CacheBehavior |
withTargetOriginId(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.
|
CacheBehavior |
withTrustedSigners(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 |
withViewerProtocolPolicy(String viewerProtocolPolicy)
Use this element to specify the protocol that users can use to access the
files in the origin specified by TargetOriginId when a request matches
the path pattern in PathPattern.
|
CacheBehavior |
withViewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
Use this element to specify the protocol that users can use to access the
files in the origin specified by TargetOriginId when a request matches
the path pattern in PathPattern.
|
public void setPathPattern(String pathPattern)
pathPattern
- The pattern (for example, images/*.jpg) that specifies which
requests you want this cache behavior to apply to. When CloudFront
receives an end-user request, the requested path is compared with
path patterns in the order in which cache behaviors are listed in
the distribution. 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.public String getPathPattern()
public CacheBehavior withPathPattern(String pathPattern)
pathPattern
- The pattern (for example, images/*.jpg) that specifies which
requests you want this cache behavior to apply to. When CloudFront
receives an end-user request, the requested path is compared with
path patterns in the order in which cache behaviors are listed in
the distribution. 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.public void setTargetOriginId(String targetOriginId)
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.public String getTargetOriginId()
public CacheBehavior withTargetOriginId(String targetOriginId)
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.public void setForwardedValues(ForwardedValues forwardedValues)
forwardedValues
- A complex type that specifies how CloudFront handles query
strings, cookies and headers.public ForwardedValues getForwardedValues()
public CacheBehavior withForwardedValues(ForwardedValues forwardedValues)
forwardedValues
- A complex type that specifies how CloudFront handles query
strings, cookies and headers.public void setTrustedSigners(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, go to Using a Signed URL to Serve
Private Content in the 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.public TrustedSigners getTrustedSigners()
public CacheBehavior withTrustedSigners(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, go to Using a Signed URL to Serve
Private Content in the 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.public void setViewerProtocolPolicy(String viewerProtocolPolicy)
viewerProtocolPolicy
- Use this element to specify the protocol that users can use to
access the files in the origin specified by TargetOriginId when a
request matches the path pattern in PathPattern. If you want
CloudFront to allow end users to use any available protocol,
specify allow-all. If you want CloudFront to require HTTPS,
specify https. If you want CloudFront to respond to an HTTP
request with an HTTP status code of 301 (Moved Permanently) and
the HTTPS URL, specify redirect-to-https. The viewer then
resubmits the request using the HTTPS URL.ViewerProtocolPolicy
public String getViewerProtocolPolicy()
ViewerProtocolPolicy
public CacheBehavior withViewerProtocolPolicy(String viewerProtocolPolicy)
viewerProtocolPolicy
- Use this element to specify the protocol that users can use to
access the files in the origin specified by TargetOriginId when a
request matches the path pattern in PathPattern. If you want
CloudFront to allow end users to use any available protocol,
specify allow-all. If you want CloudFront to require HTTPS,
specify https. If you want CloudFront to respond to an HTTP
request with an HTTP status code of 301 (Moved Permanently) and
the HTTPS URL, specify redirect-to-https. The viewer then
resubmits the request using the HTTPS URL.ViewerProtocolPolicy
public void setViewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
viewerProtocolPolicy
- Use this element to specify the protocol that users can use to
access the files in the origin specified by TargetOriginId when a
request matches the path pattern in PathPattern. If you want
CloudFront to allow end users to use any available protocol,
specify allow-all. If you want CloudFront to require HTTPS,
specify https. If you want CloudFront to respond to an HTTP
request with an HTTP status code of 301 (Moved Permanently) and
the HTTPS URL, specify redirect-to-https. The viewer then
resubmits the request using the HTTPS URL.ViewerProtocolPolicy
public CacheBehavior withViewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)
viewerProtocolPolicy
- Use this element to specify the protocol that users can use to
access the files in the origin specified by TargetOriginId when a
request matches the path pattern in PathPattern. If you want
CloudFront to allow end users to use any available protocol,
specify allow-all. If you want CloudFront to require HTTPS,
specify https. If you want CloudFront to respond to an HTTP
request with an HTTP status code of 301 (Moved Permanently) and
the HTTPS URL, specify redirect-to-https. The viewer then
resubmits the request using the HTTPS URL.ViewerProtocolPolicy
public void setMinTTL(Long minTTL)
minTTL
- The minimum amount of time that you want objects to stay in
CloudFront caches before CloudFront queries your origin to see
whether the object has been updated.You can specify a value from 0
to 3,153,600,000 seconds (100 years).public Long getMinTTL()
public CacheBehavior withMinTTL(Long minTTL)
minTTL
- The minimum amount of time that you want objects to stay in
CloudFront caches before CloudFront queries your origin to see
whether the object has been updated.You can specify a value from 0
to 3,153,600,000 seconds (100 years).public void setAllowedMethods(AllowedMethods allowedMethods)
allowedMethods
- public AllowedMethods getAllowedMethods()
public CacheBehavior withAllowedMethods(AllowedMethods allowedMethods)
allowedMethods
- public void setSmoothStreaming(Boolean smoothStreaming)
smoothStreaming
- Indicates whether you want to distribute media files in Microsoft
Smooth Streaming format using the origin that is associated with
this cache behavior. If so, specify true; if not, specify false.public Boolean getSmoothStreaming()
public CacheBehavior withSmoothStreaming(Boolean smoothStreaming)
smoothStreaming
- Indicates whether you want to distribute media files in Microsoft
Smooth Streaming format using the origin that is associated with
this cache behavior. If so, specify true; if not, specify false.public Boolean isSmoothStreaming()
public void setDefaultTTL(Long defaultTTL)
defaultTTL
- If you don't configure your origin to add a Cache-Control max-age
directive or an Expires header, DefaultTTL is the default amount
of time (in seconds) that an object is in a CloudFront cache
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. You can specify a value from 0 to 3,153,600,000
seconds (100 years).public Long getDefaultTTL()
public CacheBehavior withDefaultTTL(Long defaultTTL)
defaultTTL
- If you don't configure your origin to add a Cache-Control max-age
directive or an Expires header, DefaultTTL is the default amount
of time (in seconds) that an object is in a CloudFront cache
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. You can specify a value from 0 to 3,153,600,000
seconds (100 years).public void setMaxTTL(Long maxTTL)
maxTTL
- The maximum amount of time (in seconds) that an object is in a
CloudFront cache 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. You can specify a value from 0 to
3,153,600,000 seconds (100 years).public Long getMaxTTL()
public CacheBehavior withMaxTTL(Long maxTTL)
maxTTL
- The maximum amount of time (in seconds) that an object is in a
CloudFront cache 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. You can specify a value from 0 to
3,153,600,000 seconds (100 years).public void setCompress(Boolean compress)
compress
- Whether you want CloudFront to automatically compress content for
web requests that include Accept-Encoding: gzip in the request
header. If so, specify true; if not, specify false. CloudFront
compresses files larger than 1000 bytes and less than 1 megabyte
for both Amazon S3 and custom origins. When a CloudFront edge
location is unusually busy, some files might not be compressed.
The value of the Content-Type header must be on the list of file
types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer
Guide. If you configure CloudFront to compress content, CloudFront
removes the ETag response header from the objects that it
compresses. The ETag header indicates that the version in a
CloudFront edge cache is identical to the version on the origin
server, but after compression the two versions are no longer
identical. As a result, for compressed objects, CloudFront can't
use the ETag header to determine whether an expired object in the
CloudFront edge cache is still the latest version.public Boolean getCompress()
public CacheBehavior withCompress(Boolean compress)
compress
- Whether you want CloudFront to automatically compress content for
web requests that include Accept-Encoding: gzip in the request
header. If so, specify true; if not, specify false. CloudFront
compresses files larger than 1000 bytes and less than 1 megabyte
for both Amazon S3 and custom origins. When a CloudFront edge
location is unusually busy, some files might not be compressed.
The value of the Content-Type header must be on the list of file
types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer
Guide. If you configure CloudFront to compress content, CloudFront
removes the ETag response header from the objects that it
compresses. The ETag header indicates that the version in a
CloudFront edge cache is identical to the version on the origin
server, but after compression the two versions are no longer
identical. As a result, for compressed objects, CloudFront can't
use the ETag header to determine whether an expired object in the
CloudFront edge cache is still the latest version.public Boolean isCompress()
public String toString()
toString
in class Object
Object.toString()
public CacheBehavior clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.