com.amazonaws.services.cloudfront.model
Class DistributionConfig

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

public class DistributionConfig
extends Object

A distribution Configuration.

Constructor Summary

DistributionConfig()
Default constructor for a new DistributionConfig object.

DistributionConfig(String callerReference, Boolean enabled)
Constructs a new DistributionConfig object.

Method Summary

boolean	equals(Object obj)
String	getCallerReference() A unique number that ensures the request can't be replayed.
List<String>	getCNAME() A CNAME alias you want to associate with this distribution.
String	getComment() Any comments you want to include about the distribution.
CustomOrigin	getCustomOrigin() Origin information to associate with the distribution.
String	getDefaultRootObject() Designates a default root object.
Boolean	getEnabled() Whether the distribution is enabled to accept end user requests for content.
LoggingConfig	getLogging() A complex type that controls whether access logs are written for the distribution.
RequiredProtocols	getRequiredProtocols() Defines the protocols required for your distribution.
S3Origin	getS3Origin() Origin information to associate with the distribution.
TrustedSigners	getTrustedSigners() A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content.
int	hashCode()
Boolean	isEnabled() Whether the distribution is enabled to accept end user requests for content.
void	setCallerReference(String callerReference) A unique number that ensures the request can't be replayed.
void	setCNAME(Collection<String> cNAME) A CNAME alias you want to associate with this distribution.
void	setComment(String comment) Any comments you want to include about the distribution.
void	setCustomOrigin(CustomOrigin customOrigin) Origin information to associate with the distribution.
void	setDefaultRootObject(String defaultRootObject) Designates a default root object.
void	setEnabled(Boolean enabled) Whether the distribution is enabled to accept end user requests for content.
void	setLogging(LoggingConfig logging) A complex type that controls whether access logs are written for the distribution.
void	setRequiredProtocols(RequiredProtocols requiredProtocols) Defines the protocols required for your distribution.
void	setS3Origin(S3Origin s3Origin) Origin information to associate with the distribution.
void	setTrustedSigners(TrustedSigners trustedSigners) A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DistributionConfig	withCallerReference(String callerReference) A unique number that ensures the request can't be replayed.
DistributionConfig	withCNAME(Collection<String> cNAME) A CNAME alias you want to associate with this distribution.
DistributionConfig	withCNAME(String... cNAME) A CNAME alias you want to associate with this distribution.
DistributionConfig	withComment(String comment) Any comments you want to include about the distribution.
DistributionConfig	withCustomOrigin(CustomOrigin customOrigin) Origin information to associate with the distribution.
DistributionConfig	withDefaultRootObject(String defaultRootObject) Designates a default root object.
DistributionConfig	withEnabled(Boolean enabled) Whether the distribution is enabled to accept end user requests for content.
DistributionConfig	withLogging(LoggingConfig logging) A complex type that controls whether access logs are written for the distribution.
DistributionConfig	withRequiredProtocols(RequiredProtocols requiredProtocols) Defines the protocols required for your distribution.
DistributionConfig	withS3Origin(S3Origin s3Origin) Origin information to associate with the distribution.
DistributionConfig	withTrustedSigners(TrustedSigners trustedSigners) A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DistributionConfig

public DistributionConfig()

Default constructor for a new DistributionConfig object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DistributionConfig

public DistributionConfig(String callerReference,
                          Boolean enabled)

Constructs a new DistributionConfig object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

callerReference - A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

enabled - Whether the distribution is enabled to accept end user requests for content.

Method Detail

getS3Origin

public S3Origin getS3Origin()

Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

Returns:

Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

setS3Origin

public void setS3Origin(S3Origin s3Origin)

Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

Parameters:

s3Origin - Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

withS3Origin

public DistributionConfig withS3Origin(S3Origin s3Origin)

Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

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

Parameters:

s3Origin - Origin information to associate with the distribution. If your distribution will use an Amazon S3 origin, then you use the S3Origin element.

Returns:

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

getCustomOrigin

public CustomOrigin getCustomOrigin()

Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

Returns:

Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

setCustomOrigin

public void setCustomOrigin(CustomOrigin customOrigin)

Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

Parameters:

customOrigin - Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

withCustomOrigin

public DistributionConfig withCustomOrigin(CustomOrigin customOrigin)

Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

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

Parameters:

customOrigin - Origin information to associate with the distribution. If your distribution will use a custom origin (non Amazon S3), then you use the CustomOrigin element.

Returns:

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

getCallerReference

public String getCallerReference()

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

Returns:

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

setCallerReference

public void setCallerReference(String callerReference)

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

Parameters:

callerReference - A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

withCallerReference

public DistributionConfig withCallerReference(String callerReference)

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

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

Parameters:

callerReference - A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

Returns:

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

getCNAME

public List<String> getCNAME()

A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Returns:

A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

setCNAME

public void setCNAME(Collection<String> cNAME)

A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Parameters:

cNAME - A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

withCNAME

public DistributionConfig withCNAME(String... cNAME)

A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

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

Parameters:

cNAME - A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Returns:

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

withCNAME

public DistributionConfig withCNAME(Collection<String> cNAME)

A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

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

Parameters:

cNAME - A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Returns:

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

getComment

public String getComment()

Any comments you want to include about the distribution.

Returns:

Any comments you want to include about the distribution.

setComment

public void setComment(String comment)

Any comments you want to include about the distribution.

Parameters:

comment - Any comments you want to include about the distribution.

withComment

public DistributionConfig withComment(String comment)

Any comments you want to include about the distribution.

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

Parameters:

comment - Any comments you want to include about the distribution.

Returns:

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

isEnabled

public Boolean isEnabled()

Whether the distribution is enabled to accept end user requests for content.

Returns:

Whether the distribution is enabled to accept end user requests for content.

setEnabled

public void setEnabled(Boolean enabled)

Whether the distribution is enabled to accept end user requests for content.

Parameters:

enabled - Whether the distribution is enabled to accept end user requests for content.

withEnabled

public DistributionConfig withEnabled(Boolean enabled)

Whether the distribution is enabled to accept end user requests for content.

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

Parameters:

enabled - Whether the distribution is enabled to accept end user requests for content.

Returns:

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

getEnabled

public Boolean getEnabled()

Whether the distribution is enabled to accept end user requests for content.

Returns:

Whether the distribution is enabled to accept end user requests for content.

getLogging

public LoggingConfig getLogging()

A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

Returns:

A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

setLogging

public void setLogging(LoggingConfig logging)

A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

Parameters:

logging - A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

withLogging

public DistributionConfig withLogging(LoggingConfig logging)

A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

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

Parameters:

logging - A complex type that controls whether access logs are written for the distribution. If you want to turn on access logs, include this element; if you want to turn off access logs, remove this element.

Returns:

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

getTrustedSigners

public TrustedSigners getTrustedSigners()

A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

Returns:

A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

setTrustedSigners

public void setTrustedSigners(TrustedSigners trustedSigners)

A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

Parameters:

trustedSigners - A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

withTrustedSigners

public DistributionConfig withTrustedSigners(TrustedSigners trustedSigners)

A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

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

Parameters:

trustedSigners - A complex type that specifies any AWS accounts you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use basic URLs, remove this element.

Returns:

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

getRequiredProtocols

public RequiredProtocols getRequiredProtocols()

Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

Returns:

Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

setRequiredProtocols

public void setRequiredProtocols(RequiredProtocols requiredProtocols)

Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

Parameters:

requiredProtocols - Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

withRequiredProtocols

public DistributionConfig withRequiredProtocols(RequiredProtocols requiredProtocols)

Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

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

Parameters:

requiredProtocols - Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request.

Returns:

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

getDefaultRootObject

public String getDefaultRootObject()

Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Returns:

Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

setDefaultRootObject

public void setDefaultRootObject(String defaultRootObject)

Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

Parameters:

defaultRootObject - Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

withDefaultRootObject

public DistributionConfig withDefaultRootObject(String defaultRootObject)

Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

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

Parameters:

defaultRootObject - Designates a default root object. Only include a DefaultRootObject element if you are going to assign a default root object for the distribution. Don't include an empty DefaultRootObject element in the DistributionConfig object. If you do, CloudFront returns a MalformedXML error.

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