org.jets3t.service

Class CloudFrontService

java.lang.Object

org.jets3t.service.CloudFrontService

All Implemented Interfaces:

JetS3tRequestAuthorizer

public class CloudFrontService
extends java.lang.Object
implements JetS3tRequestAuthorizer

A service that handles communication with the Amazon CloudFront REST API, offering all the operations that can be performed on CloudFront distributions.

This class uses properties obtained through Jets3tProperties. For more information on these properties please refer to JetS3t Configuration

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_BUCKET_SUFFIX
static java.lang.String	ENDPOINT
protected org.apache.http.client.HttpClient	httpClient
protected int	internalErrorRetryMax
protected Jets3tProperties	jets3tProperties
static java.lang.String	ORIGIN_ACCESS_IDENTITY_PREFIX
static java.lang.String	ORIGIN_ACCESS_IDENTITY_URI_PATH
protected long	timeOffset The approximate difference in the current time between your computer and Amazon's servers, measured in milliseconds.
static java.lang.String	VERSION
static java.lang.String	XML_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
CloudFrontService(ProviderCredentials credentials) Constructs the service with default properties.
CloudFrontService(ProviderCredentials credentials, java.lang.String invokingApplicationDescription, org.apache.http.client.CredentialsProvider credentialsProvider, Jets3tProperties jets3tProperties) Constructs the service and initialises its properties.

Method Summary

Modifier and Type	Method and Description
void	authorizeHttpRequest(org.apache.http.client.methods.HttpUriRequest httpMethod, org.apache.http.protocol.HttpContext context, java.lang.String ignoredForceRequestSignatureVersion) Sign the given HTTP method object using the AWS credentials provided by getAWSCredentials().
protected com.jamesmurty.utils.XMLBuilder	buildCacheBehaviors(CacheBehavior[] cbs)
protected com.jamesmurty.utils.XMLBuilder	buildCacheBehaviorsElement(boolean isDefault, CacheBehavior[] cbs)
protected com.jamesmurty.utils.XMLBuilder	buildDefaultCacheBehavior(CacheBehavior cb)
protected java.lang.String	buildDistributionConfigXmlDocument(DistributionConfig config) Generate a DistributionConfig or StreamingDistributionConfig XML document.
protected com.jamesmurty.utils.XMLBuilder	buildOrigin(Origin origin) Generate XML representing an S3 or non-S3 (custom) origin.
static java.lang.String	buildPolicyForSignedUrl(java.lang.String resourcePath, java.util.Date epochDateLessThan, java.lang.String limitToIpAddressCIDR, java.util.Date epochDateGreaterThan) Generate a policy document that describes custom access permissions to apply via a private distribution's signed URL.
protected com.jamesmurty.utils.XMLBuilder	buildTrustedSigners(java.lang.String[] trustedSignerAwsAccountNumbers)
Distribution	createDistribution(DistributionConfig config) Create a public or private CloudFront distribution for an S3 bucket based on a pre-configured DistributionConfig.
Distribution	createDistribution(Origin origin) Create a minimally-configured CloudFront distribution for an S3 bucket that will be publicly available once created.
Distribution	createDistribution(Origin origin, java.lang.String callerReference, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus) Create a public CloudFront distribution for an S3 bucket.
Distribution	createDistribution(Origin origin, java.lang.String callerReference, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers, java.lang.String[] requiredProtocols, java.lang.String defaultRootObject) Create a public or private CloudFront distribution for an S3 bucket.
Distribution	createDistribution(Origin origin, java.lang.String callerReference, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers, java.lang.String[] requiredProtocols, java.lang.String defaultRootObject, java.lang.Long minTTL) Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).
protected Distribution	createDistributionImpl(DistributionConfig config) Create a streaming or non-streaming distribution.
OriginAccessIdentity	createOriginAccessIdentity(java.lang.String callerReference, java.lang.String comment) Create a new Origin Access Identity
StreamingDistribution	createStreamingDistribution(Origin origin, java.lang.String callerReference, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus) Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).
StreamingDistribution	createStreamingDistribution(Origin origin, java.lang.String callerReference, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers) Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).
void	deleteDistribution(java.lang.String id) Delete a disabled distribution.
protected void	deleteDistributionImpl(boolean isStreaming, java.lang.String distributionId) Delete a streaming or non-streaming distribution.
void	deleteOriginAccessIdentity(java.lang.String id) Delete an Origin Access Identity.
void	deleteStreamingDistribution(java.lang.String id) Delete a disabled streaming distribution.
void	disableDistributionForDeletion(java.lang.String id) Convenience method to disable a distribution that you intend to delete.
void	disableStreamingDistributionForDeletion(java.lang.String id) Convenience method to disable a streaming distribution that you intend to delete.
ProviderCredentials	getAWSCredentials()
protected java.util.Date	getCurrentTimeWithOffset() Returns the current date and time, adjusted according to the time offset between your computer and an AWS server (as set by the RestUtils.calculateTimeAdjustmentOffset(HttpResponse) method).
DistributionConfig	getDistributionConfig(java.lang.String distributionId) Lookup configuration information for a standard distribution.
protected DistributionConfig	getDistributionConfigImpl(boolean isStreaming, java.lang.String distributionId)
Distribution	getDistributionInfo(java.lang.String id) Lookup information for a standard distribution.
protected Distribution	getDistributionInfoImpl(boolean isStreaming, java.lang.String distributionId)
Invalidation	getInvalidation(java.lang.String distributionId, java.lang.String invalidationId)
OriginAccessIdentity	getOriginAccessIdentity(java.lang.String id) Obtain the complete properties of an Origin Access Identity.
OriginAccessIdentityConfig	getOriginAccessIdentityConfig(java.lang.String id) Obtain the configuration properties of an Origin Access Identity.
java.util.List<OriginAccessIdentity>	getOriginAccessIdentityList() List the Origin Access Identities in a CloudFront account.
StreamingDistributionConfig	getStreamingDistributionConfig(java.lang.String id) Lookup configuration information for a streaming distribution.
StreamingDistribution	getStreamingDistributionInfo(java.lang.String distributionId) Lookup information for a streaming distribution.
protected org.apache.http.client.HttpClient	initHttpConnection()
protected void	initializeDefaults()
protected void	initializeProxy()
Invalidation	invalidateObjects(java.lang.String distributionId, S3Object[] objects, java.lang.String callerReference) Remove distribution objects from a CloudFront edge server cache to force a refresh of the object data from the S3 origin.
Invalidation	invalidateObjects(java.lang.String distributionId, java.lang.String[] objectKeys, java.lang.String callerReference) Remove distribution objects from a CloudFront edge server cache to force a refresh of the object data from the S3 origin.
Distribution[]	listDistributions() List all your standard CloudFront distributions.
Distribution[]	listDistributions(int pagingSize) List all your standard CloudFront distributions, with a given maximum number of Distribution items in each "page" of results.
Distribution[]	listDistributions(java.lang.String bucketName) List the distributions whose origin is the given S3 bucket name.
java.util.List<Distribution>	listDistributionsByBucketName(boolean isStreaming, java.lang.String bucketName) List streaming or non-stream distributions whose origin is the given S3 bucket name.
protected java.util.List<Distribution>	listDistributionsImpl(boolean isStreaming, int pagingSize) List streaming or non-streaming Distributions in a CloudFront account.
java.util.List<InvalidationSummary>	listInvalidations(java.lang.String distributionId) List all past invalidation summaries, ordered from most recent to oldest.
InvalidationList	listInvalidations(java.lang.String distributionId, java.lang.String nextMarker, int pagingSize) List a single page of up to pagingSize past invalidation summaries, ordered from most recent to oldest.
StreamingDistribution[]	listStreamingDistributions() List all your streaming CloudFront distributions.
StreamingDistribution[]	listStreamingDistributions(int pagingSize) List all your streaming CloudFront distributions, with a given maximum number of Distribution items in each "page" of results.
StreamingDistribution[]	listStreamingDistributions(java.lang.String bucketName) List the streaming distributions whose origin is the given S3 bucket name.
protected static java.lang.String	makeBytesUrlSafe(byte[] bytes) Convert the given data to be safe for use in signed URLs for a private distribution by using specialized Base64 encoding.
protected static java.lang.String	makeStringUrlSafe(java.lang.String str) Convert the given string to be safe for use in signed URLs for a private distribution.
protected org.apache.http.HttpResponse	performRestRequest(org.apache.http.client.methods.HttpRequestBase httpMethod, int expectedResponseCode) Performs an HTTP/S request by invoking the provided HttpMethod object.
static java.lang.String	sanitizeS3BucketName(java.lang.String proposedBucketName) Sanitizes a proposed bucket name to ensure it is fully-specified rather than merely the bucket's short name.
static java.lang.String	signUrl(java.lang.String resourceUrlOrPath, java.lang.String keyPairId, byte[] derPrivateKey, java.lang.String policy) Generate a signed URL that allows access to distribution and S3 objects by applying access restrictions specified in a custom policy document.
static java.lang.String	signUrlCanned(java.lang.String resourceUrlOrPath, java.lang.String keyPairId, byte[] derPrivateKey, java.util.Date epochDateLessThan) Generate a signed URL that allows access to a specific distribution and S3 object by applying a access restrictions from a "canned" (simplified) policy document.
DistributionConfig	updateDistributionConfig(java.lang.String id, DistributionConfig config) Update the configuration of an existing distribution to change its properties or public/private status.
DistributionConfig	updateDistributionConfig(java.lang.String id, Origin origin, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus) Update the configuration of an existing distribution to change its properties.
DistributionConfig	updateDistributionConfig(java.lang.String id, Origin origin, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers, java.lang.String[] requiredProtocols, java.lang.String defaultRootObject) Update the configuration of an existing distribution to change its properties or public/private status.
DistributionConfig	updateDistributionConfig(java.lang.String id, Origin origin, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers, java.lang.String[] requiredProtocols, java.lang.String defaultRootObject, java.lang.Long minTTL) Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).
protected DistributionConfig	updateDistributionConfigImpl(java.lang.String id, DistributionConfig config) Update a streaming or non-streaming distribution.
OriginAccessIdentityConfig	updateOriginAccessIdentityConfig(java.lang.String id, java.lang.String comment) Update the properties of an Origin Access Identity.
StreamingDistributionConfig	updateStreamingDistributionConfig(java.lang.String id, Origin origin, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus) Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).
StreamingDistributionConfig	updateStreamingDistributionConfig(java.lang.String id, Origin origin, java.lang.String[] cnames, java.lang.String comment, boolean enabled, LoggingStatus loggingStatus, boolean trustedSignerSelf, java.lang.String[] trustedSignerAwsAccountNumbers) Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENDPOINT

public static final java.lang.String ENDPOINT

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

XML_NAMESPACE

public static final java.lang.String XML_NAMESPACE

See Also:

Constant Field Values

DEFAULT_BUCKET_SUFFIX

public static final java.lang.String DEFAULT_BUCKET_SUFFIX

See Also:

Constant Field Values

ORIGIN_ACCESS_IDENTITY_URI_PATH

public static final java.lang.String ORIGIN_ACCESS_IDENTITY_URI_PATH

See Also:

Constant Field Values

ORIGIN_ACCESS_IDENTITY_PREFIX

public static final java.lang.String ORIGIN_ACCESS_IDENTITY_PREFIX

See Also:

Constant Field Values

httpClient

protected org.apache.http.client.HttpClient httpClient

jets3tProperties

protected Jets3tProperties jets3tProperties

internalErrorRetryMax

protected int internalErrorRetryMax

timeOffset

protected long timeOffset

The approximate difference in the current time between your computer and Amazon's servers, measured in milliseconds.

This value is 0 by default. Use the getCurrentTimeWithOffset() to obtain the current time with this offset factor included, and the RestUtils.calculateTimeAdjustmentOffset(HttpResponse) method to calculate an offset value for your computer based on a response from an AWS server.

Constructor Detail

CloudFrontService

public CloudFrontService(ProviderCredentials credentials,
                         java.lang.String invokingApplicationDescription,
                         org.apache.http.client.CredentialsProvider credentialsProvider,
                         Jets3tProperties jets3tProperties)

Constructs the service and initialises its properties.

Parameters:

credentials - the Storage Provider user credentials to use when communicating with CloudFront

invokingApplicationDescription - a short description of the application using the service, suitable for inclusion in a user agent string for REST/HTTP requests. Ideally this would include the application's version number, for example: Cockpit/0.7.3 or My App Name/1.0. May be null.

credentialsProvider - an implementation of the HttpClient CredentialsProvider interface, to provide a means for prompting for credentials when necessary. May be null.

jets3tProperties - JetS3t properties that will be applied within this service. May be null.

CloudFrontService

public CloudFrontService(ProviderCredentials credentials)

Constructs the service with default properties.

Parameters:

credentials - the Storage Provider user credentials to use when communicating with CloudFront

Method Detail

initializeDefaults

protected void initializeDefaults()

initHttpConnection

protected org.apache.http.client.HttpClient initHttpConnection()

initializeProxy

protected void initializeProxy()

getAWSCredentials

public ProviderCredentials getAWSCredentials()

Returns:

the Storage Provider Credentials identifying the AWS user.

getCurrentTimeWithOffset

protected java.util.Date getCurrentTimeWithOffset()

Returns the current date and time, adjusted according to the time offset between your computer and an AWS server (as set by the RestUtils.calculateTimeAdjustmentOffset(HttpResponse) method).

Returns:

the current time, or the current time adjusted to match the AWS time if the service has experienced a RequestExpired error.

authorizeHttpRequest

public void authorizeHttpRequest(org.apache.http.client.methods.HttpUriRequest httpMethod,
                                 org.apache.http.protocol.HttpContext context,
                                 java.lang.String ignoredForceRequestSignatureVersion)
                          throws ServiceException

Sign the given HTTP method object using the AWS credentials provided by getAWSCredentials().

Specified by:

authorizeHttpRequest in interface JetS3tRequestAuthorizer

Parameters:

httpMethod - the request object

context -

ignoredForceRequestSignatureVersion - ignored parameter relevant only for AWS4-HMAC-SHA256 request signing.

Throws:

ServiceException

performRestRequest

protected org.apache.http.HttpResponse performRestRequest(org.apache.http.client.methods.HttpRequestBase httpMethod,
                                                          int expectedResponseCode)
                                                   throws CloudFrontServiceException

Performs an HTTP/S request by invoking the provided HttpMethod object. If the HTTP response code doesn't match the expected value, an exception is thrown.

Parameters:

httpMethod - the object containing a request target and all other information necessary to perform the request

expectedResponseCode - the HTTP response code that indicates a successful request. If the response code received does not match this value an error must have occurred, so an exception is thrown.

Throws:

CloudFrontServiceException - all exceptions are wrapped in a CloudFrontServiceException. Depending on the kind of error that occurred, this exception may contain additional error information available from an XML error response document.

listDistributionsImpl

protected java.util.List<Distribution> listDistributionsImpl(boolean isStreaming,
                                                             int pagingSize)
                                                      throws CloudFrontServiceException

List streaming or non-streaming Distributions in a CloudFront account.

Parameters:

isStreaming - Only return streaming distributions

pagingSize - the maximum number of distributions the CloudFront service will return in each response message.

Returns:

A list of Distributions.

Throws:

CloudFrontServiceException - exception

listDistributions

public Distribution[] listDistributions(int pagingSize)
                                 throws CloudFrontServiceException

List all your standard CloudFront distributions, with a given maximum number of Distribution items in each "page" of results.

Parameters:

pagingSize - the maximum number of distributions the CloudFront service will return in each response message.

Returns:

a list of your distributions.

Throws:

CloudFrontServiceException - exception

listStreamingDistributions

public StreamingDistribution[] listStreamingDistributions(int pagingSize)
                                                   throws CloudFrontServiceException

List all your streaming CloudFront distributions, with a given maximum number of Distribution items in each "page" of results.

Parameters:

pagingSize - the maximum number of distributions the CloudFront service will return in each response message.

Returns:

a list of your distributions.

Throws:

CloudFrontServiceException - exception

listDistributions

public Distribution[] listDistributions()
                                 throws CloudFrontServiceException

List all your standard CloudFront distributions.

Returns:

a list of your distributions.

Throws:

CloudFrontServiceException - exception

listStreamingDistributions

public StreamingDistribution[] listStreamingDistributions()
                                                   throws CloudFrontServiceException

List all your streaming CloudFront distributions.

Returns:

a list of your streaming distributions.

Throws:

CloudFrontServiceException - exception

listDistributionsByBucketName

public java.util.List<Distribution> listDistributionsByBucketName(boolean isStreaming,
                                                                  java.lang.String bucketName)
                                                           throws CloudFrontServiceException

List streaming or non-stream distributions whose origin is the given S3 bucket name.

Parameters:

isStreaming - List streaming distributions

bucketName - the name of the S3 bucket whose distributions will be returned.

Returns:

a list of distributions applied to the given S3 bucket, or an empty list if there are no such distributions.

Throws:

CloudFrontServiceException - exception

listDistributions

public Distribution[] listDistributions(java.lang.String bucketName)
                                 throws CloudFrontServiceException

List the distributions whose origin is the given S3 bucket name.

Parameters:

bucketName - the name of the S3 bucket whose distributions will be returned.

Returns:

a list of distributions applied to the given S3 bucket, or an empty list if there are no such distributions.

Throws:

CloudFrontServiceException - exception

listStreamingDistributions

public StreamingDistribution[] listStreamingDistributions(java.lang.String bucketName)
                                                   throws CloudFrontServiceException

List the streaming distributions whose origin is the given S3 bucket name.

Parameters:

bucketName - the name of the S3 bucket whose distributions will be returned.

Returns:

a list of distributions applied to the given S3 bucket, or an empty list if there are no such distributions.

Throws:

CloudFrontServiceException - exception

buildOrigin

protected com.jamesmurty.utils.XMLBuilder buildOrigin(Origin origin)
                                               throws javax.xml.transform.TransformerException,
                                                      javax.xml.parsers.ParserConfigurationException,
                                                      javax.xml.parsers.FactoryConfigurationError

Generate XML representing an S3 or non-S3 (custom) origin.

Parameters:

origin - S3 or non-S3 (custom) origin.

Returns:

XML document representing an origin

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

buildTrustedSigners

protected com.jamesmurty.utils.XMLBuilder buildTrustedSigners(java.lang.String[] trustedSignerAwsAccountNumbers)
                                                       throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

buildDefaultCacheBehavior

protected com.jamesmurty.utils.XMLBuilder buildDefaultCacheBehavior(CacheBehavior cb)
                                                             throws javax.xml.transform.TransformerException,
                                                                    javax.xml.parsers.ParserConfigurationException,
                                                                    javax.xml.parsers.FactoryConfigurationError

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

buildCacheBehaviors

protected com.jamesmurty.utils.XMLBuilder buildCacheBehaviors(CacheBehavior[] cbs)
                                                       throws javax.xml.transform.TransformerException,
                                                              javax.xml.parsers.ParserConfigurationException,
                                                              javax.xml.parsers.FactoryConfigurationError

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

buildCacheBehaviorsElement

protected com.jamesmurty.utils.XMLBuilder buildCacheBehaviorsElement(boolean isDefault,
                                                                     CacheBehavior[] cbs)
                                                              throws javax.xml.transform.TransformerException,
                                                                     javax.xml.parsers.ParserConfigurationException,
                                                                     javax.xml.parsers.FactoryConfigurationError

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

buildDistributionConfigXmlDocument

protected java.lang.String buildDistributionConfigXmlDocument(DistributionConfig config)
                                                       throws javax.xml.transform.TransformerException,
                                                              javax.xml.parsers.ParserConfigurationException,
                                                              javax.xml.parsers.FactoryConfigurationError

Generate a DistributionConfig or StreamingDistributionConfig XML document.

Returns:

XML document representing a Distribution Configuration

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

createDistributionImpl

protected Distribution createDistributionImpl(DistributionConfig config)
                                       throws CloudFrontServiceException

Create a streaming or non-streaming distribution.

Parameters:

config - Configuration document

Returns:

Information about the newly-created distribution.

Throws:

CloudFrontServiceException - exception

createDistribution

public Distribution createDistribution(Origin origin,
                                       java.lang.String callerReference,
                                       java.lang.String[] cnames,
                                       java.lang.String comment,
                                       boolean enabled,
                                       LoggingStatus loggingStatus,
                                       boolean trustedSignerSelf,
                                       java.lang.String[] trustedSignerAwsAccountNumbers,
                                       java.lang.String[] requiredProtocols,
                                       java.lang.String defaultRootObject)
                                throws CloudFrontServiceException

Create a public or private CloudFront distribution for an S3 bucket.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be a null or empty array.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null.

enabled - Should the distribution should be enabled and publicly accessible upon creation?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

requiredProtocols - List of protocols that must be used by clients to retrieve content from the distribution. If this value is null or is an empty array, all protocols will be supported.

defaultRootObject - The name of an object that will be served when someone visits the root of a distribution.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException - exception

createDistribution

@Deprecated
public Distribution createDistribution(Origin origin,
                                                   java.lang.String callerReference,
                                                   java.lang.String[] cnames,
                                                   java.lang.String comment,
                                                   boolean enabled,
                                                   LoggingStatus loggingStatus,
                                                   boolean trustedSignerSelf,
                                                   java.lang.String[] trustedSignerAwsAccountNumbers,
                                                   java.lang.String[] requiredProtocols,
                                                   java.lang.String defaultRootObject,
                                                   java.lang.Long minTTL)
                                            throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).

Create a public or private CloudFront distribution for an S3 bucket.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be a null or empty array.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null.

enabled - Should the distribution should be enabled and publicly accessible upon creation?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

requiredProtocols - List of protocols that must be used by clients to retrieve content from the distribution. If this value is null or is an empty array, all protocols will be supported.

defaultRootObject - The name of an object that will be served when someone visits the root of a distribution.

minTTL - The time to live (TTL) to apply to objects served by this distribution.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

createDistribution

public Distribution createDistribution(Origin origin)
                                throws CloudFrontServiceException

Create a minimally-configured CloudFront distribution for an S3 bucket that will be publicly available once created.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

createDistribution

public Distribution createDistribution(Origin origin,
                                       java.lang.String callerReference,
                                       java.lang.String[] cnames,
                                       java.lang.String comment,
                                       boolean enabled,
                                       LoggingStatus loggingStatus)
                                throws CloudFrontServiceException

Create a public CloudFront distribution for an S3 bucket.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be a null or empty array.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null.

enabled - Should the distribution should be enabled and publicly accessible upon creation?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

createDistribution

public Distribution createDistribution(DistributionConfig config)
                                throws CloudFrontServiceException

Create a public or private CloudFront distribution for an S3 bucket based on a pre-configured DistributionConfig.

Parameters:

config - Configuration settings to apply to the distribution.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

createStreamingDistribution

@Deprecated
public StreamingDistribution createStreamingDistribution(Origin origin,
                                                                     java.lang.String callerReference,
                                                                     java.lang.String[] cnames,
                                                                     java.lang.String comment,
                                                                     boolean enabled,
                                                                     LoggingStatus loggingStatus,
                                                                     boolean trustedSignerSelf,
                                                                     java.lang.String[] trustedSignerAwsAccountNumbers)
                                                              throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).

Create a public or private streaming CloudFront distribution for an S3 bucket.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be a null or empty array.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null.

enabled - Should the distribution should be enabled and publicly accessible upon creation?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

createStreamingDistribution

@Deprecated
public StreamingDistribution createStreamingDistribution(Origin origin,
                                                                     java.lang.String callerReference,
                                                                     java.lang.String[] cnames,
                                                                     java.lang.String comment,
                                                                     boolean enabled,
                                                                     LoggingStatus loggingStatus)
                                                              throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use createDistribution(DistributionConfig).

Create a public streaming CloudFront distribution for an S3 bucket.

Parameters:

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be a null or empty array.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null.

enabled - Should the distribution should be enabled and publicly accessible upon creation?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

Returns:

an object that describes the newly-created distribution, in particular the distribution's identifier and domain name values.

Throws:

CloudFrontServiceException

getDistributionInfoImpl

protected Distribution getDistributionInfoImpl(boolean isStreaming,
                                               java.lang.String distributionId)
                                        throws CloudFrontServiceException

Parameters:

isStreaming - Only return streaming distributions

distributionId - The distribution's unique identifier.

Returns:

Information about a streaming or non-streaming distribution.

Throws:

CloudFrontServiceException

getDistributionInfo

public Distribution getDistributionInfo(java.lang.String id)
                                 throws CloudFrontServiceException

Lookup information for a standard distribution.

Parameters:

id - the distribution's unique identifier.

Returns:

an object that describes the distribution, including its identifier and domain name values as well as its configuration details.

Throws:

CloudFrontServiceException

getStreamingDistributionInfo

public StreamingDistribution getStreamingDistributionInfo(java.lang.String distributionId)
                                                   throws CloudFrontServiceException

Lookup information for a streaming distribution.

Parameters:

distributionId - the distribution's unique identifier.

Returns:

an object that describes the distribution, including its identifier and domain name values as well as its configuration details.

Throws:

CloudFrontServiceException

getDistributionConfigImpl

protected DistributionConfig getDistributionConfigImpl(boolean isStreaming,
                                                       java.lang.String distributionId)
                                                throws CloudFrontServiceException

Parameters:

isStreaming - Only return streaming distributions

distributionId - The distribution's unique identifier.

Returns:

Information about a streaming or non-streaming distribution configuration.

Throws:

CloudFrontServiceException

getDistributionConfig

public DistributionConfig getDistributionConfig(java.lang.String distributionId)
                                         throws CloudFrontServiceException

Lookup configuration information for a standard distribution. The configuration information is a subset of the information available from the getDistributionInfo(String) method.

Parameters:

distributionId - the distribution's unique identifier.

Returns:

an object that describes the distribution's configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

getStreamingDistributionConfig

public StreamingDistributionConfig getStreamingDistributionConfig(java.lang.String id)
                                                           throws CloudFrontServiceException

Lookup configuration information for a streaming distribution. The configuration information is a subset of the information available from the getDistributionInfo(String) method.

Parameters:

id - the distribution's unique identifier.

Returns:

an object that describes the distribution's configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateDistributionConfigImpl

protected DistributionConfig updateDistributionConfigImpl(java.lang.String id,
                                                          DistributionConfig config)
                                                   throws CloudFrontServiceException

Update a streaming or non-streaming distribution.

Parameters:

config - Configuration properties to apply to the distribution.

Returns:

Information about the updated distribution configuration.

Throws:

CloudFrontServiceException

updateDistributionConfig

@Deprecated
public DistributionConfig updateDistributionConfig(java.lang.String id,
                                                               Origin origin,
                                                               java.lang.String[] cnames,
                                                               java.lang.String comment,
                                                               boolean enabled,
                                                               LoggingStatus loggingStatus,
                                                               boolean trustedSignerSelf,
                                                               java.lang.String[] trustedSignerAwsAccountNumbers,
                                                               java.lang.String[] requiredProtocols,
                                                               java.lang.String defaultRootObject,
                                                               java.lang.Long minTTL)
                                                        throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).

Update the configuration of an existing distribution to change its properties or public/private status. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be null, in which case the original CNAME aliases are retained.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null, in which case the original comment is retained.

enabled - Should the distribution should be enabled and publicly accessible after the configuration update?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

requiredProtocols - List of protocols that must be used by clients to retrieve content from the distribution. If this value is null or is an empty array all protocols will be permitted.

defaultRootObject - The name of an object that will be served when someone visits the root of a distribution.

minTTL - The time to live (TTL) to apply to objects served by this distribution.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateDistributionConfig

public DistributionConfig updateDistributionConfig(java.lang.String id,
                                                   Origin origin,
                                                   java.lang.String[] cnames,
                                                   java.lang.String comment,
                                                   boolean enabled,
                                                   LoggingStatus loggingStatus,
                                                   boolean trustedSignerSelf,
                                                   java.lang.String[] trustedSignerAwsAccountNumbers,
                                                   java.lang.String[] requiredProtocols,
                                                   java.lang.String defaultRootObject)
                                            throws CloudFrontServiceException

Update the configuration of an existing distribution to change its properties or public/private status. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be null, in which case the original CNAME aliases are retained.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null, in which case the original comment is retained.

enabled - Should the distribution should be enabled and publicly accessible after the configuration update?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

requiredProtocols - List of protocols that must be used by clients to retrieve content from the distribution. If this value is null or is an empty array all protocols will be permitted.

defaultRootObject - The name of an object that will be served when someone visits the root of a distribution.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateStreamingDistributionConfig

@Deprecated
public StreamingDistributionConfig updateStreamingDistributionConfig(java.lang.String id,
                                                                                 Origin origin,
                                                                                 java.lang.String[] cnames,
                                                                                 java.lang.String comment,
                                                                                 boolean enabled,
                                                                                 LoggingStatus loggingStatus)
                                                                          throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).

Update the configuration of an existing streaming distribution to change its properties. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be null, in which case the original CNAME aliases are retained.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null, in which case the original comment is retained.

enabled - Should the distribution should be enabled and publicly accessible after the configuration update?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateStreamingDistributionConfig

@Deprecated
public StreamingDistributionConfig updateStreamingDistributionConfig(java.lang.String id,
                                                                                 Origin origin,
                                                                                 java.lang.String[] cnames,
                                                                                 java.lang.String comment,
                                                                                 boolean enabled,
                                                                                 LoggingStatus loggingStatus,
                                                                                 boolean trustedSignerSelf,
                                                                                 java.lang.String[] trustedSignerAwsAccountNumbers)
                                                                          throws CloudFrontServiceException

Deprecated. as of 2012-05-05 API version, use updateDistributionConfig(String, DistributionConfig).

Update the configuration of an existing streaming distribution to change its properties. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be null, in which case the original CNAME aliases are retained.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null, in which case the original comment is retained.

enabled - Should the distribution should be enabled and publicly accessible after the configuration update?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

trustedSignerSelf - If true the owner of the distribution (you) will be be allowed to generate signed URLs for a private distribution. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

trustedSignerAwsAccountNumbers - Account Number identifiers for AWS account holders other than the distribution's owner who will be allowed to generate signed URLs for a private distribution. If null or empty, no additional AWS account holders may generate signed URLs. Note: If either trustedSignerSelf or trustedSignerAwsAccountNumbers parameters are provided the private distribution will require signed URLs to access content.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateDistributionConfig

public DistributionConfig updateDistributionConfig(java.lang.String id,
                                                   Origin origin,
                                                   java.lang.String[] cnames,
                                                   java.lang.String comment,
                                                   boolean enabled,
                                                   LoggingStatus loggingStatus)
                                            throws CloudFrontServiceException

Update the configuration of an existing distribution to change its properties. If the original distribution is private this method will make it public instead. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

origin - the origin to associate with the distribution, either an Amazon S3 bucket or a custom HTTP/S-accessible location.

cnames - A list of up to 10 CNAME aliases to associate with the distribution. This parameter may be null, in which case the original CNAME aliases are retained.

comment - An optional comment to describe the distribution in your own terms (max 128 characters). May be null, in which case the original comment is retained.

enabled - Should the distribution should be enabled and publicly accessible after the configuration update?

loggingStatus - Logging status settings (bucket, prefix) for the distribution. If this value is null, logging will be disabled for the distribution.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

updateDistributionConfig

public DistributionConfig updateDistributionConfig(java.lang.String id,
                                                   DistributionConfig config)
                                            throws CloudFrontServiceException

Update the configuration of an existing distribution to change its properties or public/private status. The new configuration properties provided replace any existing configuration, and may take some time to be fully applied.

This method performs all the steps necessary to update the configuration. It first performs lookup on the distribution using getDistributionConfig(String) to find its origin and caller reference values, then uses this information to apply your configuration changes.

Parameters:

id - the distribution's unique identifier.

config - Configuration properties to apply to the distribution.

Returns:

an object that describes the distribution's updated configuration, including its origin bucket and CNAME aliases.

Throws:

CloudFrontServiceException

disableDistributionForDeletion

public void disableDistributionForDeletion(java.lang.String id)
                                    throws CloudFrontServiceException

Convenience method to disable a distribution that you intend to delete. This method merely calls the updateDistributionConfig(String, Origin, String[], String, boolean, LoggingStatus) method with default values for most of the distribution's configuration settings.

Warning: Do not use this method on distributions you intend to keep, because it will reset most of the distribution's configuration settings such as CNAMEs and logging status.

Parameters:

id - the distribution's unique identifier.

Throws:

CloudFrontServiceException

disableStreamingDistributionForDeletion

public void disableStreamingDistributionForDeletion(java.lang.String id)
                                             throws CloudFrontServiceException

Convenience method to disable a streaming distribution that you intend to delete. This method merely calls the updateStreamingDistributionConfig(String, Origin, String[], String, boolean, LoggingStatus) method with default values for most of the distribution's configuration settings.

Warning: Do not use this method on distributions you intend to keep, because it will reset most of the distribution's configuration settings such as CNAMEs and logging status.

Parameters:

id - the distribution's unique identifier.

Throws:

CloudFrontServiceException

deleteDistributionImpl

protected void deleteDistributionImpl(boolean isStreaming,
                                      java.lang.String distributionId)
                               throws CloudFrontServiceException

Delete a streaming or non-streaming distribution.

Parameters:

isStreaming - Only return streaming distributions

distributionId - The distribution's unique identifier.

Throws:

CloudFrontServiceException

deleteDistribution

public void deleteDistribution(java.lang.String id)
                        throws CloudFrontServiceException

Delete a disabled distribution. You can only delete a distribution that is already disabled, if you delete an enabled distribution this operation will fail with a DistributionNotDisabled error.

This method performs many of the steps necessary to delete a disabled distribution. It first performs lookup on the distribution using getDistributionConfig(String) to find its ETag value, then uses this information to delete the distribution.

Because it can take a long time (minutes) to disable a distribution, this task is not performed automatically by this method. In your own code, you need to verify that a distribution is disabled with a status of Deployed before you invoke this method.

Parameters:

id - the distribution's unique identifier.

Throws:

CloudFrontServiceException

deleteStreamingDistribution

public void deleteStreamingDistribution(java.lang.String id)
                                 throws CloudFrontServiceException

Delete a disabled streaming distribution. You can only delete a distribution that is already disabled, if you delete an enabled distribution this operation will fail with a DistributionNotDisabled error.

This method performs many of the steps necessary to delete a disabled distribution. It first performs lookup on the distribution using getDistributionConfig(String) to find its ETag value, then uses this information to delete the distribution.

Because it can take a long time (minutes) to disable a distribution, this task is not performed automatically by this method. In your own code, you need to verify that a distribution is disabled with a status of Deployed before you invoke this method.

Parameters:

id - the distribution's unique identifier.

Throws:

CloudFrontServiceException

createOriginAccessIdentity

public OriginAccessIdentity createOriginAccessIdentity(java.lang.String callerReference,
                                                       java.lang.String comment)
                                                throws CloudFrontServiceException

Create a new Origin Access Identity

Parameters:

callerReference - A user-set unique reference value that ensures the request can't be replayed (max UTF-8 encoding size 128 bytes). This parameter may be null, in which case your computer's local epoch time in milliseconds will be used.

comment - An optional comment to describe the identity (max 128 characters). May be null.

Returns:

The origin access identity's properties.

Throws:

CloudFrontServiceException

getOriginAccessIdentityList

public java.util.List<OriginAccessIdentity> getOriginAccessIdentityList()
                                                                 throws CloudFrontServiceException

List the Origin Access Identities in a CloudFront account.

Returns:

List of OriginAccessIdentity objects describing the identities.

Throws:

CloudFrontServiceException

getOriginAccessIdentity

public OriginAccessIdentity getOriginAccessIdentity(java.lang.String id)
                                             throws CloudFrontServiceException

Obtain the complete properties of an Origin Access Identity.

Parameters:

id - The identifier of the Origin Access Identity.

Returns:

The origin access identity's properties.

Throws:

CloudFrontServiceException

getOriginAccessIdentityConfig

public OriginAccessIdentityConfig getOriginAccessIdentityConfig(java.lang.String id)
                                                         throws CloudFrontServiceException

Obtain the configuration properties of an Origin Access Identity.

Parameters:

id - The identifier of the Origin Access Identity.

Returns:

The origin access identity's configuration properties.

Throws:

CloudFrontServiceException

updateOriginAccessIdentityConfig

public OriginAccessIdentityConfig updateOriginAccessIdentityConfig(java.lang.String id,
                                                                   java.lang.String comment)
                                                            throws CloudFrontServiceException

Update the properties of an Origin Access Identity.

Parameters:

id - The identifier of the Origin Access Identity.

comment - A new comment to apply to the identity.

Returns:

The origin access identity's configuration properties.

Throws:

CloudFrontServiceException

deleteOriginAccessIdentity

public void deleteOriginAccessIdentity(java.lang.String id)
                                throws CloudFrontServiceException

Delete an Origin Access Identity.

Parameters:

id - The identifier of the Origin Access Identity.

Throws:

CloudFrontServiceException - exception

invalidateObjects

public Invalidation invalidateObjects(java.lang.String distributionId,
                                      java.lang.String[] objectKeys,
                                      java.lang.String callerReference)
                               throws CloudFrontServiceException

Remove distribution objects from a CloudFront edge server cache to force a refresh of the object data from the S3 origin.

Parameters:

distributionId - The distribution's unique identifier.

objectKeys - S3 object key names of object(s) to invalidate.

callerReference - Unique description for this distribution config

Returns:

invalidation object

Throws:

CloudFrontServiceException - exception

invalidateObjects

public Invalidation invalidateObjects(java.lang.String distributionId,
                                      S3Object[] objects,
                                      java.lang.String callerReference)
                               throws CloudFrontServiceException

Remove distribution objects from a CloudFront edge server cache to force a refresh of the object data from the S3 origin.

Parameters:

distributionId - The distribution's unique identifier.

objects - S3 object(s) to invalidate.

callerReference - Unique description for this distribution config

Returns:

invalidation object

Throws:

CloudFrontServiceException - exception

getInvalidation

public Invalidation getInvalidation(java.lang.String distributionId,
                                    java.lang.String invalidationId)
                             throws CloudFrontServiceException

Parameters:

distributionId - The distribution's unique identifier.

invalidationId - The identifier for the invalidation request

Returns:

Details of a prior invalidation operation.

Throws:

CloudFrontServiceException - exception

listInvalidations

public InvalidationList listInvalidations(java.lang.String distributionId,
                                          java.lang.String nextMarker,
                                          int pagingSize)
                                   throws CloudFrontServiceException

List a single page of up to pagingSize past invalidation summaries, ordered from most recent to oldest. If there are more prior invalidations than will fit on the page you must perform follow-up calls to this method to obtain a complete listing.

Parameters:

distributionId - The distribution's unique identifier.

nextMarker - a marker string indicating where to begin the next page of listing results. Start with null for an initial listing page, then set to the NextMarker value of each subsequent page returned.

pagingSize - maximum number of invalidation summaries to include in each result page, up to 100.

Returns:

invalidation listing

Throws:

CloudFrontServiceException - exception

listInvalidations

public java.util.List<InvalidationSummary> listInvalidations(java.lang.String distributionId)
                                                      throws CloudFrontServiceException

List all past invalidation summaries, ordered from most recent to oldest.

Parameters:

distributionId - The distribution's unique identifier.

Returns:

list of invalidation objects

Throws:

CloudFrontServiceException - exception

sanitizeS3BucketName

public static java.lang.String sanitizeS3BucketName(java.lang.String proposedBucketName)

Sanitizes a proposed bucket name to ensure it is fully-specified rather than merely the bucket's short name. A fully specified bucket name looks like "jets3t.s3.amazonaws.com".

Parameters:

proposedBucketName - the proposed S3 bucket name that will be sanitized.

Returns:

the bucket name with the DEFAULT_BUCKET_SUFFIX added, if necessary.

makeStringUrlSafe

protected static java.lang.String makeStringUrlSafe(java.lang.String str)
                                             throws java.io.UnsupportedEncodingException

Convert the given string to be safe for use in signed URLs for a private distribution.

Parameters:

str -

Returns:

a URL-safe Base64 encoded version of the data.

Throws:

java.io.UnsupportedEncodingException

makeBytesUrlSafe

protected static java.lang.String makeBytesUrlSafe(byte[] bytes)
                                            throws java.io.UnsupportedEncodingException

Convert the given data to be safe for use in signed URLs for a private distribution by using specialized Base64 encoding.

Parameters:

bytes -

Returns:

a URL-safe Base64 encoded version of the data.

Throws:

java.io.UnsupportedEncodingException

buildPolicyForSignedUrl

public static java.lang.String buildPolicyForSignedUrl(java.lang.String resourcePath,
                                                       java.util.Date epochDateLessThan,
                                                       java.lang.String limitToIpAddressCIDR,
                                                       java.util.Date epochDateGreaterThan)
                                                throws CloudFrontServiceException

Generate a policy document that describes custom access permissions to apply via a private distribution's signed URL.

Parameters:

resourcePath - An optional HTTP/S or RTMP resource path that restricts which distribution and S3 objects will be accessible in a signed URL. For standard distributions the resource URL will be "http://" + distributionName + "/" + objectKey (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with "https://". RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name.

The '*' and '?' characters can be used as a wildcards to allow multi-character or single-character matches respectively:

• * : All distributions/objects will be accessible
• a1b2c3d4e5f6g7.cloudfront.net/* : All objects within the distribution a1b2c3d4e5f6g7 will be accessible
• a1b2c3d4e5f6g7.cloudfront.net/path/to/object.txt : Only the S3 object named path/to/object.txt in the distribution a1b2c3d4e5f6g7 will be accessible.

If this parameter is null the policy will permit access to all distributions and S3 objects associated with the certificate keypair used to generate the signed URL.

epochDateLessThan - The time and date when the signed URL will expire. REQUIRED.

limitToIpAddressCIDR - An optional range of client IP addresses that will be allowed to access the distribution, specified as a CIDR range. If null, the CIDR will be 0.0.0.0/0 and any client will be permitted.

epochDateGreaterThan - An optional time and date when the signed URL will become active. If null, the signed URL will be active as soon as it is created.

Returns:

A policy document describing the access permission to apply when generating a signed URL.

Throws:

CloudFrontServiceException - exception

signUrl

public static java.lang.String signUrl(java.lang.String resourceUrlOrPath,
                                       java.lang.String keyPairId,
                                       byte[] derPrivateKey,
                                       java.lang.String policy)
                                throws CloudFrontServiceException

Generate a signed URL that allows access to distribution and S3 objects by applying access restrictions specified in a custom policy document.

Parameters:

resourceUrlOrPath - The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be "http://" + distributionName + "/" + objectKey (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with "https://". RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name.

keyPairId - Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.

derPrivateKey - The RSA private key data that corresponding to the certificate keypair identified by keyPairId, in DER format. To convert a standard PEM private key file into this format use the utility method EncryptionUtil.convertRsaPemToDer(java.io.InputStream)

policy - A policy document that describes the access permissions that will be applied by the signed URL. To generate a custom policy use buildPolicyForSignedUrl(String, Date, String, Date).

Returns:

A signed URL that will permit access to distribution and S3 objects as specified in the policy document.

Throws:

CloudFrontServiceException - exception

signUrlCanned

public static java.lang.String signUrlCanned(java.lang.String resourceUrlOrPath,
                                             java.lang.String keyPairId,
                                             byte[] derPrivateKey,
                                             java.util.Date epochDateLessThan)
                                      throws CloudFrontServiceException

Generate a signed URL that allows access to a specific distribution and S3 object by applying a access restrictions from a "canned" (simplified) policy document.

Parameters:

resourceUrlOrPath - The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be "http://" + distributionName + "/" + objectKey (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with "https://". RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name.

keyPairId - Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.

derPrivateKey - The RSA private key data that corresponding to the certificate keypair identified by keyPairId, in DER format. To convert a standard PEM private key file into this format use the utility method EncryptionUtil.convertRsaPemToDer(java.io.InputStream)

epochDateLessThan - The time and date when the signed URL will expire. REQUIRED.

Returns:

A signed URL that will permit access to a specific distribution and S3 object.

Throws:

CloudFrontServiceException - exception