public class CacheBehavior extends Object implements Serializable
A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
Constructor and Description |
---|
CacheBehavior() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
AllowedMethods |
getAllowedMethods()
A complex type that controls which HTTP methods CloudFront processes
and forwards to your Amazon S3 bucket or your custom origin.
|
ForwardedValues |
getForwardedValues()
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
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 |
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)
A complex type that controls which HTTP methods CloudFront processes
and forwards to your Amazon S3 bucket or your custom origin.
|
void |
setForwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
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)
A complex type that controls which HTTP methods CloudFront processes
and forwards to your Amazon S3 bucket or your custom origin.
|
CacheBehavior |
withForwardedValues(ForwardedValues forwardedValues)
A complex type that specifies how CloudFront handles query strings,
cookies and headers.
|
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 String getPathPattern()
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 CacheBehavior withPathPattern(String pathPattern)
Returns a reference to this object so that method calls can be chained together.
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 getTargetOriginId()
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 CacheBehavior withTargetOriginId(String targetOriginId)
Returns a reference to this object so that method calls can be chained together.
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 ForwardedValues getForwardedValues()
public void setForwardedValues(ForwardedValues forwardedValues)
forwardedValues
- A complex type that specifies how CloudFront handles query strings,
cookies and headers.public CacheBehavior withForwardedValues(ForwardedValues forwardedValues)
Returns a reference to this object so that method calls can be chained together.
forwardedValues
- A complex type that specifies how CloudFront handles query strings,
cookies and headers.public TrustedSigners getTrustedSigners()
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 CacheBehavior withTrustedSigners(TrustedSigners trustedSigners)
Returns a reference to this object so that method calls can be chained together.
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 String getViewerProtocolPolicy()
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
ViewerProtocolPolicy
public void setViewerProtocolPolicy(String viewerProtocolPolicy)
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
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(String viewerProtocolPolicy)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
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)
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
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)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
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 Long getMinTTL()
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 CacheBehavior withMinTTL(Long minTTL)
Returns a reference to this object so that method calls can be chained together.
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 AllowedMethods getAllowedMethods()
public void setAllowedMethods(AllowedMethods allowedMethods)
allowedMethods
- A complex type that controls which HTTP methods CloudFront processes
and forwards to your Amazon S3 bucket or your custom origin. There are
two options: - CloudFront forwards only GET and HEAD requests. -
CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT
requests. If you choose the second option, you may need to restrict
access to your Amazon S3 bucket or to your custom origin so users
can't perform operations that you don't want them to. For example, you
may not want users to have permission to delete objects from your
origin.public CacheBehavior withAllowedMethods(AllowedMethods allowedMethods)
Returns a reference to this object so that method calls can be chained together.
allowedMethods
- A complex type that controls which HTTP methods CloudFront processes
and forwards to your Amazon S3 bucket or your custom origin. There are
two options: - CloudFront forwards only GET and HEAD requests. -
CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT
requests. If you choose the second option, you may need to restrict
access to your Amazon S3 bucket or to your custom origin so users
can't perform operations that you don't want them to. For example, you
may not want users to have permission to delete objects from your
origin.public Boolean isSmoothStreaming()
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 CacheBehavior withSmoothStreaming(Boolean smoothStreaming)
Returns a reference to this object so that method calls can be chained together.
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 String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.