com.amazonaws.services.cloudfront.model
Class CacheBehavior

java.lang.Object
  com.amazonaws.services.cloudfront.model.CacheBehavior

All Implemented Interfaces:

Serializable

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.

See Also:

Serialized Form

Constructor Summary

CacheBehavior()

Method Summary

boolean	equals(Object obj)
ForwardedValues	getForwardedValues() A complex type that specifies how CloudFront handles query strings and cookies.
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.
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()
void	setForwardedValues(ForwardedValues forwardedValues) A complex type that specifies how CloudFront handles query strings and cookies.
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	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	withForwardedValues(ForwardedValues forwardedValues) A complex type that specifies how CloudFront handles query strings and cookies.
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	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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheBehavior

public CacheBehavior()

Method Detail

getPathPattern

public String getPathPattern()

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.

Returns:

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.

setPathPattern

public void setPathPattern(String 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.

Parameters:

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.

withPathPattern

public CacheBehavior withPathPattern(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetOriginId

public 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.

Returns:

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.

setTargetOriginId

public 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.

Parameters:

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.

withTargetOriginId

public 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getForwardedValues

public ForwardedValues getForwardedValues()

A complex type that specifies how CloudFront handles query strings and cookies.

Returns:

A complex type that specifies how CloudFront handles query strings and cookies.

setForwardedValues

public void setForwardedValues(ForwardedValues forwardedValues)

A complex type that specifies how CloudFront handles query strings and cookies.

Parameters:

forwardedValues - A complex type that specifies how CloudFront handles query strings and cookies.

withForwardedValues

public CacheBehavior withForwardedValues(ForwardedValues forwardedValues)

A complex type that specifies how CloudFront handles query strings and cookies.

Returns a reference to this object so that method calls can be chained together.

Parameters:

forwardedValues - A complex type that specifies how CloudFront handles query strings and cookies.

Returns:

A reference to this updated object so that method calls can be chained together.

getTrustedSigners

public TrustedSigners getTrustedSigners()

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.

Returns:

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.

setTrustedSigners

public 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. 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.

Parameters:

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.

withTrustedSigners

public 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. 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getViewerProtocolPolicy

public 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. 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.

Constraints:
Allowed Values: allow-all, https-only

Returns:

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.

See Also:

ViewerProtocolPolicy

setViewerProtocolPolicy

public 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. 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.

Constraints:
Allowed Values: allow-all, https-only

Parameters:

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.

See Also:

ViewerProtocolPolicy

withViewerProtocolPolicy

public 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. 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: allow-all, https-only

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ViewerProtocolPolicy

setViewerProtocolPolicy

public 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. 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.

Constraints:
Allowed Values: allow-all, https-only

Parameters:

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.

See Also:

ViewerProtocolPolicy

withViewerProtocolPolicy

public 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. 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: allow-all, https-only

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ViewerProtocolPolicy

getMinTTL

public 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).

Returns:

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).

setMinTTL

public 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).

Parameters:

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).

withMinTTL

public 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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

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).

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object