Interface AmazonCloudFront
- All Known Subinterfaces:
AmazonCloudFrontAsync
- All Known Implementing Classes:
AbstractAmazonCloudFront
,AbstractAmazonCloudFrontAsync
,AmazonCloudFrontAsyncClient
,AmazonCloudFrontClient
-
Method Summary
Modifier and TypeMethodDescriptioncreateCloudFrontOriginAccessIdentity
(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest) Create a new origin access identity.createDistribution
(CreateDistributionRequest createDistributionRequest) Create a new distribution.createInvalidation
(CreateInvalidationRequest createInvalidationRequest) Create a new invalidation.createStreamingDistribution
(CreateStreamingDistributionRequest createStreamingDistributionRequest) Create a new streaming distribution.deleteCloudFrontOriginAccessIdentity
(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) Delete an origin access identity.deleteDistribution
(DeleteDistributionRequest deleteDistributionRequest) Delete a distribution.deleteStreamingDistribution
(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) Delete a streaming distribution.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getCloudFrontOriginAccessIdentity
(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) Get the information about an origin access identity.getCloudFrontOriginAccessIdentityConfig
(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) Get the configuration information about an origin access identity.getDistribution
(GetDistributionRequest getDistributionRequest) Get the information about a distribution.getDistributionConfig
(GetDistributionConfigRequest getDistributionConfigRequest) Get the configuration information about a distribution.getInvalidation
(GetInvalidationRequest getInvalidationRequest) Get the information about an invalidation.getStreamingDistribution
(GetStreamingDistributionRequest getStreamingDistributionRequest) Get the information about a streaming distribution.getStreamingDistributionConfig
(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) Get the configuration information about a streaming distribution.listCloudFrontOriginAccessIdentities
(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) List origin access identities.listDistributions
(ListDistributionsRequest listDistributionsRequest) List distributions.listDistributionsByWebACLId
(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest) List the distributions that are associated with a specified AWS WAF web ACL.listInvalidations
(ListInvalidationsRequest listInvalidationsRequest) List invalidation batches.listStreamingDistributions
(ListStreamingDistributionsRequest listStreamingDistributionsRequest) List streaming distributions.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://cloudfront.amazonaws.com/").void
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.updateCloudFrontOriginAccessIdentity
(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) Update an origin access identity.updateDistribution
(UpdateDistributionRequest updateDistributionRequest) Update a distribution.updateStreamingDistribution
(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) Update a streaming distribution.
-
Method Details
-
setEndpoint
Overrides the default endpoint for this client ("https://cloudfront.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudfront.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
endpoint
- The endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudfront.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
-
setRegion
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
createCloudFrontOriginAccessIdentity
CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest) Create a new origin access identity.- Parameters:
createCloudFrontOriginAccessIdentityRequest
- The request to create a new origin access identity.- Returns:
- Result of the CreateCloudFrontOriginAccessIdentity operation returned by the service.
- Throws:
CloudFrontOriginAccessIdentityAlreadyExistsException
- If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.TooManyCloudFrontOriginAccessIdentitiesException
- Processing your request would cause you to exceed the maximum number of origin access identities allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.
-
createDistribution
Create a new distribution.- Parameters:
createDistributionRequest
- The request to create a new distribution.- Returns:
- Result of the CreateDistribution operation returned by the service.
- Throws:
CNAMEAlreadyExistsException
DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers do not exist.InvalidViewerCertificateException
InvalidMinimumProtocolVersionException
MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
InvalidResponseCodeException
InvalidArgumentException
- The argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id.TooManyOriginsException
- You cannot create anymore origins for the distribution.TooManyCacheBehaviorsException
- You cannot create anymore cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
InvalidHeadersForS3OriginException
InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.TooManyCertificatesException
- You cannot create anymore custom ssl certificates.InvalidLocationCodeException
InvalidGeoRestrictionParameterException
InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).InvalidTTLOrderException
InvalidWebACLIdException
TooManyOriginCustomHeadersException
-
createInvalidation
Create a new invalidation.- Parameters:
createInvalidationRequest
- The request to create an invalidation.- Returns:
- Result of the CreateInvalidation operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.InvalidArgumentException
- The argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.BatchTooLargeException
TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.
-
createStreamingDistribution
CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) Create a new streaming distribution.- Parameters:
createStreamingDistributionRequest
- The request to create a new streaming distribution.- Returns:
- Result of the CreateStreamingDistribution operation returned by the service.
- Throws:
CNAMEAlreadyExistsException
StreamingDistributionAlreadyExistsException
InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers do not exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.TooManyStreamingDistributionCNAMEsException
TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.
-
deleteCloudFrontOriginAccessIdentity
DeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) Delete an origin access identity.- Parameters:
deleteCloudFrontOriginAccessIdentityRequest
- The request to delete a origin access identity.- Returns:
- Result of the DeleteCloudFrontOriginAccessIdentity operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.CloudFrontOriginAccessIdentityInUseException
-
deleteDistribution
Delete a distribution.- Parameters:
deleteDistributionRequest
- The request to delete a distribution.- Returns:
- Result of the DeleteDistribution operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.DistributionNotDisabledException
InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.
-
deleteStreamingDistribution
DeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) Delete a streaming distribution.- Parameters:
deleteStreamingDistributionRequest
- The request to delete a streaming distribution.- Returns:
- Result of the DeleteStreamingDistribution operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.StreamingDistributionNotDisabledException
InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.
-
getCloudFrontOriginAccessIdentity
GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) Get the information about an origin access identity.- Parameters:
getCloudFrontOriginAccessIdentityRequest
- The request to get an origin access identity's information.- Returns:
- Result of the GetCloudFrontOriginAccessIdentity operation returned by the service.
- Throws:
NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.
-
getCloudFrontOriginAccessIdentityConfig
GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) Get the configuration information about an origin access identity.- Parameters:
getCloudFrontOriginAccessIdentityConfigRequest
- The request to get an origin access identity's configuration.- Returns:
- Result of the GetCloudFrontOriginAccessIdentityConfig operation returned by the service.
- Throws:
NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.
-
getDistribution
Get the information about a distribution.- Parameters:
getDistributionRequest
- The request to get a distribution's information.- Returns:
- Result of the GetDistribution operation returned by the service.
- Throws:
NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.
-
getDistributionConfig
GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest) Get the configuration information about a distribution.- Parameters:
getDistributionConfigRequest
- The request to get a distribution configuration.- Returns:
- Result of the GetDistributionConfig operation returned by the service.
- Throws:
NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.
-
getInvalidation
Get the information about an invalidation.- Parameters:
getInvalidationRequest
- The request to get an invalidation's information.- Returns:
- Result of the GetInvalidation operation returned by the service.
- Throws:
NoSuchInvalidationException
- The specified invalidation does not exist.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.
-
getStreamingDistribution
GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest) Get the information about a streaming distribution.- Parameters:
getStreamingDistributionRequest
- The request to get a streaming distribution's information.- Returns:
- Result of the GetStreamingDistribution operation returned by the service.
- Throws:
NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.
-
getStreamingDistributionConfig
GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) Get the configuration information about a streaming distribution.- Parameters:
getStreamingDistributionConfigRequest
- To request to get a streaming distribution configuration.- Returns:
- Result of the GetStreamingDistributionConfig operation returned by the service.
- Throws:
NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.
-
listCloudFrontOriginAccessIdentities
ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) List origin access identities.- Parameters:
listCloudFrontOriginAccessIdentitiesRequest
- The request to list origin access identities.- Returns:
- Result of the ListCloudFrontOriginAccessIdentities operation returned by the service.
- Throws:
InvalidArgumentException
- The argument is invalid.
-
listDistributions
List distributions.- Parameters:
listDistributionsRequest
- The request to list your distributions.- Returns:
- Result of the ListDistributions operation returned by the service.
- Throws:
InvalidArgumentException
- The argument is invalid.
-
listDistributionsByWebACLId
ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest) List the distributions that are associated with a specified AWS WAF web ACL.- Parameters:
listDistributionsByWebACLIdRequest
- The request to list distributions that are associated with a specified AWS WAF web ACL.- Returns:
- Result of the ListDistributionsByWebACLId operation returned by the service.
- Throws:
InvalidArgumentException
- The argument is invalid.InvalidWebACLIdException
-
listInvalidations
List invalidation batches.- Parameters:
listInvalidationsRequest
- The request to list invalidations.- Returns:
- Result of the ListInvalidations operation returned by the service.
- Throws:
InvalidArgumentException
- The argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.
-
listStreamingDistributions
ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest) List streaming distributions.- Parameters:
listStreamingDistributionsRequest
- The request to list your streaming distributions.- Returns:
- Result of the ListStreamingDistributions operation returned by the service.
- Throws:
InvalidArgumentException
- The argument is invalid.
-
updateCloudFrontOriginAccessIdentity
UpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) Update an origin access identity.- Parameters:
updateCloudFrontOriginAccessIdentityRequest
- The request to update an origin access identity.- Returns:
- Result of the UpdateCloudFrontOriginAccessIdentity operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.IllegalUpdateException
- Origin and CallerReference cannot be updated.InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.
-
updateDistribution
Update a distribution.- Parameters:
updateDistributionRequest
- The request to update a distribution.- Returns:
- Result of the UpdateDistribution operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.CNAMEAlreadyExistsException
IllegalUpdateException
- Origin and CallerReference cannot be updated.InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
InvalidResponseCodeException
InvalidArgumentException
- The argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers do not exist.InvalidViewerCertificateException
InvalidMinimumProtocolVersionException
InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id.TooManyOriginsException
- You cannot create anymore origins for the distribution.TooManyCacheBehaviorsException
- You cannot create anymore cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
InvalidHeadersForS3OriginException
InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.TooManyCertificatesException
- You cannot create anymore custom ssl certificates.InvalidLocationCodeException
InvalidGeoRestrictionParameterException
InvalidTTLOrderException
InvalidWebACLIdException
TooManyOriginCustomHeadersException
-
updateStreamingDistribution
UpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) Update a streaming distribution.- Parameters:
updateStreamingDistributionRequest
- The request to update a streaming distribution.- Returns:
- Result of the UpdateStreamingDistribution operation returned by the service.
- Throws:
AccessDeniedException
- Access denied.CNAMEAlreadyExistsException
IllegalUpdateException
- Origin and CallerReference cannot be updated.InvalidIfMatchVersionException
- The If-Match version is missing or not valid for the distribution.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type header is set.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false.TooManyStreamingDistributionCNAMEsException
InvalidArgumentException
- The argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers do not exist.InconsistentQuantitiesException
- The value of Quantity and the size of Items do not match.
-
shutdown
void shutdown()Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests. -
getCachedResponseMetadata
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-