com.amazonaws.services.lightsail.model

Class CacheBehaviorPerPath

java.lang.Object

com.amazonaws.services.lightsail.model.CacheBehaviorPerPath

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CacheBehaviorPerPath
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheBehaviorPerPath()

Method Summary

Modifier and Type	Method and Description
CacheBehaviorPerPath	clone()
boolean	equals(Object obj)
String	getBehavior() The cache behavior for the specified path.
String	getPath() The path to a directory or file to cached, or not cache.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBehavior(String behavior) The cache behavior for the specified path.
void	setPath(String path) The path to a directory or file to cached, or not cache.
String	toString() Returns a string representation of this object.
CacheBehaviorPerPath	withBehavior(BehaviorEnum behavior) The cache behavior for the specified path.
CacheBehaviorPerPath	withBehavior(String behavior) The cache behavior for the specified path.
CacheBehaviorPerPath	withPath(String path) The path to a directory or file to cached, or not cache.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheBehaviorPerPath

public CacheBehaviorPerPath()

Method Detail

setPath

public void setPath(String path)

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

Parameters:

path - The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

getPath

public String getPath()

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

Returns:

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

withPath

public CacheBehaviorPerPath withPath(String path)

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

Parameters:

path - The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

Returns:

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

setBehavior

public void setBehavior(String behavior)

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Parameters:

behavior - The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

See Also:

BehaviorEnum

getBehavior

public String getBehavior()

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Returns:

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

See Also:

BehaviorEnum

withBehavior

public CacheBehaviorPerPath withBehavior(String behavior)

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Parameters:

behavior - The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Returns:

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

See Also:

BehaviorEnum

withBehavior

public CacheBehaviorPerPath withBehavior(BehaviorEnum behavior)

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Parameters:

behavior - The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

Returns:

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

See Also:

BehaviorEnum

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CacheBehaviorPerPath clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.