@Generated(value="software.amazon.awssdk:codegen") public interface CloudFrontAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static CloudFrontAsyncClient create()
CloudFrontAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CloudFrontAsyncClientBuilder builder()
CloudFrontAsyncClient
.default CompletableFuture<CreateCloudFrontOriginAccessIdentityResponse> createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
createCloudFrontOriginAccessIdentityRequest
- The request to create a new origin access identity.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.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateCloudFrontOriginAccessIdentityResponse> createCloudFrontOriginAccessIdentity(Consumer<CreateCloudFrontOriginAccessIdentityRequest.Builder> createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
CreateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
CreateCloudFrontOriginAccessIdentityRequest.builder()
createCloudFrontOriginAccessIdentityRequest
- a Consumer
that will call methods on CreateCloudFrontOriginAccessIdentityRequest.Builder
.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.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateDistributionResponse> createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution. Send a POST
request to the
/CloudFront API version/distribution
/distribution ID
resource.
createDistributionRequest
- The request to create a new distribution.Content-Type
header is set.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<CreateDistributionResponse> createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)
Creates a new web distribution. Send a POST
request to the
/CloudFront API version/distribution
/distribution ID
resource.
CreateDistributionRequest.Builder
avoiding the
need to create one manually via CreateDistributionRequest.builder()
createDistributionRequest
- a Consumer
that will call methods on CreateDistributionRequest.Builder
.Content-Type
header is set.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<CreateDistributionWithTagsResponse> createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
Create a new distribution with tags.
createDistributionWithTagsRequest
- The request to create a new distribution with tags.Content-Type
header is set.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<CreateDistributionWithTagsResponse> createDistributionWithTags(Consumer<CreateDistributionWithTagsRequest.Builder> createDistributionWithTagsRequest)
Create a new distribution with tags.
CreateDistributionWithTagsRequest.Builder
avoiding
the need to create one manually via CreateDistributionWithTagsRequest.builder()
createDistributionWithTagsRequest
- a Consumer
that will call methods on CreateDistributionWithTagsRequest.Builder
.Content-Type
header is set.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<CreateInvalidationResponse> createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
createInvalidationRequest
- The request to create an invalidation.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateInvalidationResponse> createInvalidation(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest)
Create a new invalidation.
CreateInvalidationRequest.Builder
avoiding the
need to create one manually via CreateInvalidationRequest.builder()
createInvalidationRequest
- a Consumer
that will call methods on CreateInvalidationRequest.Builder
.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateStreamingDistributionResponse> createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.
To create a new web distribution, submit a POST
request to the CloudFront API
version/distribution resource. The request body must include a document with a
StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig
element and returns other information about the RTMP distribution.
To get the status of your request, use the GET StreamingDistribution API action. When the value of
Enabled
is true
and the value of Status
is Deployed
, your
distribution is ready. A distribution usually deploys in less than 15 minutes.
For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.
Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML
document that you include in the request body when you create or update a web distribution or an RTMP
distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too
easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs
and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions
and to notify you when there's a mismatch between the number of values you say you're specifying in the
Quantity
element and the number of values specified.
createStreamingDistributionRequest
- The request to create a new streaming distribution.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateStreamingDistributionResponse> createStreamingDistribution(Consumer<CreateStreamingDistributionRequest.Builder> createStreamingDistributionRequest)
Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.
To create a new web distribution, submit a POST
request to the CloudFront API
version/distribution resource. The request body must include a document with a
StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig
element and returns other information about the RTMP distribution.
To get the status of your request, use the GET StreamingDistribution API action. When the value of
Enabled
is true
and the value of Status
is Deployed
, your
distribution is ready. A distribution usually deploys in less than 15 minutes.
For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.
Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML
document that you include in the request body when you create or update a web distribution or an RTMP
distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too
easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs
and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions
and to notify you when there's a mismatch between the number of values you say you're specifying in the
Quantity
element and the number of values specified.
CreateStreamingDistributionRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionRequest.builder()
createStreamingDistributionRequest
- a Consumer
that will call methods on CreateStreamingDistributionRequest.Builder
.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateStreamingDistributionWithTagsResponse> createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
Create a new streaming distribution with tags.
createStreamingDistributionWithTagsRequest
- The request to create a new streaming distribution with tags.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreateStreamingDistributionWithTagsResponse> createStreamingDistributionWithTags(Consumer<CreateStreamingDistributionWithTagsRequest.Builder> createStreamingDistributionWithTagsRequest)
Create a new streaming distribution with tags.
CreateStreamingDistributionWithTagsRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionWithTagsRequest.builder()
createStreamingDistributionWithTagsRequest
- a Consumer
that will call methods on CreateStreamingDistributionWithTagsRequest.Builder
.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<DeleteCloudFrontOriginAccessIdentityResponse> deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentityRequest
- Deletes a origin access identity.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteCloudFrontOriginAccessIdentityResponse> deleteCloudFrontOriginAccessIdentity(Consumer<DeleteCloudFrontOriginAccessIdentityRequest.Builder> deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
DeleteCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
DeleteCloudFrontOriginAccessIdentityRequest.builder()
deleteCloudFrontOriginAccessIdentityRequest
- a Consumer
that will call methods on DeleteCloudFrontOriginAccessIdentityRequest.Builder
.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteDistributionResponse> deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
deleteDistributionRequest
- This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the
following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config
request to get the current configuration and the
Etag
header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config
request to change the value of Enabled
to false
.
Submit a PUT Distribution Config
request to update the configuration for your distribution.
In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP
If-Match
header to the value of the ETag
header that CloudFront returned when
you submitted the GET Distribution Config
request in Step 2.
Review the response to the PUT Distribution Config
request to confirm that the distribution
was successfully disabled.
Submit a GET Distribution
request to confirm that your changes have propagated. When
propagation is complete, the value of Status
is Deployed
.
Submit a DELETE Distribution
request. Set the value of the HTTP If-Match
header
to the value of the ETag
header that CloudFront returned when you submitted the
GET Distribution Config
request in Step 6.
Review the response to your DELETE Distribution
request to confirm that the distribution was
successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteDistributionResponse> deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)
Delete a distribution.
DeleteDistributionRequest.Builder
avoiding the
need to create one manually via DeleteDistributionRequest.builder()
deleteDistributionRequest
- a Consumer
that will call methods on DeleteDistributionRequest.Builder
.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteServiceLinkedRoleResponse> deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest)
deleteServiceLinkedRoleRequest
- default CompletableFuture<DeleteServiceLinkedRoleResponse> deleteServiceLinkedRole(Consumer<DeleteServiceLinkedRoleRequest.Builder> deleteServiceLinkedRoleRequest)
DeleteServiceLinkedRoleRequest.Builder
avoiding
the need to create one manually via DeleteServiceLinkedRoleRequest.builder()
deleteServiceLinkedRoleRequest
- a Consumer
that will call methods on DeleteServiceLinkedRoleRequest.Builder
.default CompletableFuture<DeleteStreamingDistributionResponse> deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config
request to get the current configuration and the
Etag
header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config
request to change the value of Enabled
to false
.
Submit a PUT Streaming Distribution Config
request to update the configuration for your
distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the
HTTP If-Match
header to the value of the ETag
header that CloudFront returned when you
submitted the GET Streaming Distribution Config
request in Step 2.
Review the response to the PUT Streaming Distribution Config
request to confirm that the
distribution was successfully disabled.
Submit a GET Streaming Distribution Config
request to confirm that your changes have propagated.
When propagation is complete, the value of Status
is Deployed
.
Submit a DELETE Streaming Distribution
request. Set the value of the HTTP If-Match
header to the value of the ETag
header that CloudFront returned when you submitted the
GET Streaming Distribution Config
request in Step 2.
Review the response to your DELETE Streaming Distribution
request to confirm that the distribution
was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
deleteStreamingDistributionRequest
- The request to delete a streaming distribution.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteStreamingDistributionResponse> deleteStreamingDistribution(Consumer<DeleteStreamingDistributionRequest.Builder> deleteStreamingDistributionRequest)
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config
request to get the current configuration and the
Etag
header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config
request to change the value of Enabled
to false
.
Submit a PUT Streaming Distribution Config
request to update the configuration for your
distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the
HTTP If-Match
header to the value of the ETag
header that CloudFront returned when you
submitted the GET Streaming Distribution Config
request in Step 2.
Review the response to the PUT Streaming Distribution Config
request to confirm that the
distribution was successfully disabled.
Submit a GET Streaming Distribution Config
request to confirm that your changes have propagated.
When propagation is complete, the value of Status
is Deployed
.
Submit a DELETE Streaming Distribution
request. Set the value of the HTTP If-Match
header to the value of the ETag
header that CloudFront returned when you submitted the
GET Streaming Distribution Config
request in Step 2.
Review the response to your DELETE Streaming Distribution
request to confirm that the distribution
was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
DeleteStreamingDistributionRequest.Builder
avoiding the need to create one manually via DeleteStreamingDistributionRequest.builder()
deleteStreamingDistributionRequest
- a Consumer
that will call methods on DeleteStreamingDistributionRequest.Builder
.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<GetCloudFrontOriginAccessIdentityResponse> getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentityRequest
- The request to get an origin access identity's information.default CompletableFuture<GetCloudFrontOriginAccessIdentityResponse> getCloudFrontOriginAccessIdentity(Consumer<GetCloudFrontOriginAccessIdentityRequest.Builder> getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
GetCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via GetCloudFrontOriginAccessIdentityRequest.builder()
getCloudFrontOriginAccessIdentityRequest
- a Consumer
that will call methods on GetCloudFrontOriginAccessIdentityRequest.Builder
.default CompletableFuture<GetCloudFrontOriginAccessIdentityConfigResponse> getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfigRequest
- The origin access identity's configuration information. For more information, see
CloudFrontOriginAccessIdentityConfigComplexType.default CompletableFuture<GetCloudFrontOriginAccessIdentityConfigResponse> getCloudFrontOriginAccessIdentityConfig(Consumer<GetCloudFrontOriginAccessIdentityConfigRequest.Builder> getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
avoiding the need to create one manually via
GetCloudFrontOriginAccessIdentityConfigRequest.builder()
getCloudFrontOriginAccessIdentityConfigRequest
- a Consumer
that will call methods on
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
.default CompletableFuture<GetDistributionResponse> getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
getDistributionRequest
- The request to get a distribution's information.default CompletableFuture<GetDistributionResponse> getDistribution(Consumer<GetDistributionRequest.Builder> getDistributionRequest)
Get the information about a distribution.
GetDistributionRequest.Builder
avoiding the need
to create one manually via GetDistributionRequest.builder()
getDistributionRequest
- a Consumer
that will call methods on GetDistributionRequest.Builder
.default CompletableFuture<GetDistributionConfigResponse> getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
getDistributionConfigRequest
- The request to get a distribution configuration.default CompletableFuture<GetDistributionConfigResponse> getDistributionConfig(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest)
Get the configuration information about a distribution.
GetDistributionConfigRequest.Builder
avoiding the
need to create one manually via GetDistributionConfigRequest.builder()
getDistributionConfigRequest
- a Consumer
that will call methods on GetDistributionConfigRequest.Builder
.default CompletableFuture<GetInvalidationResponse> getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
getInvalidationRequest
- The request to get an invalidation's information.default CompletableFuture<GetInvalidationResponse> getInvalidation(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest)
Get the information about an invalidation.
GetInvalidationRequest.Builder
avoiding the need
to create one manually via GetInvalidationRequest.builder()
getInvalidationRequest
- a Consumer
that will call methods on GetInvalidationRequest.Builder
.default CompletableFuture<GetStreamingDistributionResponse> getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistributionRequest
- The request to get a streaming distribution's information.default CompletableFuture<GetStreamingDistributionResponse> getStreamingDistribution(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
GetStreamingDistributionRequest.Builder
avoiding
the need to create one manually via GetStreamingDistributionRequest.builder()
getStreamingDistributionRequest
- a Consumer
that will call methods on GetStreamingDistributionRequest.Builder
.default CompletableFuture<GetStreamingDistributionConfigResponse> getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
getStreamingDistributionConfigRequest
- To request to get a streaming distribution configuration.default CompletableFuture<GetStreamingDistributionConfigResponse> getStreamingDistributionConfig(Consumer<GetStreamingDistributionConfigRequest.Builder> getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
GetStreamingDistributionConfigRequest.Builder
avoiding the need to create one manually via GetStreamingDistributionConfigRequest.builder()
getStreamingDistributionConfigRequest
- a Consumer
that will call methods on GetStreamingDistributionConfigRequest.Builder
.default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest
- The request to list origin access identities.default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities()
Lists origin access identities.
default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
ListCloudFrontOriginAccessIdentitiesRequest.Builder
avoiding the need to create one manually via
ListCloudFrontOriginAccessIdentitiesRequest.builder()
listCloudFrontOriginAccessIdentitiesRequest
- a Consumer
that will call methods on ListCloudFrontOriginAccessIdentitiesRequest.Builder
.default CompletableFuture<ListDistributionsResponse> listDistributions(ListDistributionsRequest listDistributionsRequest)
List distributions.
listDistributionsRequest
- The request to list your distributions.default CompletableFuture<ListDistributionsResponse> listDistributions()
List distributions.
default CompletableFuture<ListDistributionsResponse> listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest)
List distributions.
ListDistributionsRequest.Builder
avoiding the need
to create one manually via ListDistributionsRequest.builder()
listDistributionsRequest
- a Consumer
that will call methods on ListDistributionsRequest.Builder
.default CompletableFuture<ListDistributionsByWebACLIdResponse> listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest)
List the distributions that are associated with a specified AWS WAF web ACL.
listDistributionsByWebACLIdRequest
- The request to list distributions that are associated with a specified AWS WAF web ACL.default CompletableFuture<ListDistributionsByWebACLIdResponse> listDistributionsByWebACLId(Consumer<ListDistributionsByWebACLIdRequest.Builder> listDistributionsByWebACLIdRequest)
List the distributions that are associated with a specified AWS WAF web ACL.
ListDistributionsByWebACLIdRequest.Builder
avoiding the need to create one manually via ListDistributionsByWebACLIdRequest.builder()
listDistributionsByWebACLIdRequest
- a Consumer
that will call methods on ListDistributionsByWebACLIdRequest.Builder
.default CompletableFuture<ListInvalidationsResponse> listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
listInvalidationsRequest
- The request to list invalidations.default CompletableFuture<ListInvalidationsResponse> listInvalidations(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest)
Lists invalidation batches.
ListInvalidationsRequest.Builder
avoiding the need
to create one manually via ListInvalidationsRequest.builder()
listInvalidationsRequest
- a Consumer
that will call methods on ListInvalidationsRequest.Builder
.default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
listStreamingDistributionsRequest
- The request to list your streaming distributions.default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions()
List streaming distributions.
default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest)
List streaming distributions.
ListStreamingDistributionsRequest.Builder
avoiding
the need to create one manually via ListStreamingDistributionsRequest.builder()
listStreamingDistributionsRequest
- a Consumer
that will call methods on ListStreamingDistributionsRequest.Builder
.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
listTagsForResourceRequest
- The request to list tags for a CloudFront resource.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a CloudFront resource.
ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- a Consumer
that will call methods on ListTagsForResourceRequest.Builder
.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
tagResourceRequest
- The request to add tags to a CloudFront resource.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add tags to a CloudFront resource.
TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- a Consumer
that will call methods on TagResourceRequest.Builder
.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
untagResourceRequest
- The request to remove tags from a CloudFront resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove tags from a CloudFront resource.
UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- a Consumer
that will call methods on UntagResourceRequest.Builder
.default CompletableFuture<UpdateCloudFrontOriginAccessIdentityResponse> updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
updateCloudFrontOriginAccessIdentityRequest
- The request to update an origin access identity.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.Quantity
and the size of Items
don't match.default CompletableFuture<UpdateCloudFrontOriginAccessIdentityResponse> updateCloudFrontOriginAccessIdentity(Consumer<UpdateCloudFrontOriginAccessIdentityRequest.Builder> updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
UpdateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
UpdateCloudFrontOriginAccessIdentityRequest.builder()
updateCloudFrontOriginAccessIdentityRequest
- a Consumer
that will call methods on UpdateCloudFrontOriginAccessIdentityRequest.Builder
.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.Quantity
and the size of Items
don't match.default CompletableFuture<UpdateDistributionResponse> updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution. Perform the following steps.
For information about updating a distribution using the CloudFront console, see Creating or Updating a Web Distribution Using the CloudFront Console in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a GetDistributionConfig request to get the current configuration and an Etag
header
for the distribution.
If you update the distribution again, you need to get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include the desired changes. You can't change the value of CallerReference
. If you try to change
this value, CloudFront returns an IllegalUpdate
error.
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistribution
request are not merged into the existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, CNAME
), you must specify all
of the values that you want to appear in the updated distribution. In addition, you must update the corresponding
Quantity
element.
Submit an UpdateDistribution
request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an XML
document with a DistributionConfig
element.
Set the value of the HTTP If-Match
header to the value of the ETag
header that
CloudFront returned when you submitted the GetDistributionConfig
request in Step 1.
Review the response to the UpdateDistribution
request to confirm that the configuration was
successfully updated.
Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation
is complete, the value of Status
is Deployed
.
Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML
document that you include in the request body when you create or update a distribution. With previous versions of
the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts
multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to
prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say
you're specifying in the Quantity
element and the number of values you're actually specifying.
updateDistributionRequest
- The request to update a distribution.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<UpdateDistributionResponse> updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest)
Updates the configuration for a web distribution. Perform the following steps.
For information about updating a distribution using the CloudFront console, see Creating or Updating a Web Distribution Using the CloudFront Console in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a GetDistributionConfig request to get the current configuration and an Etag
header
for the distribution.
If you update the distribution again, you need to get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include the desired changes. You can't change the value of CallerReference
. If you try to change
this value, CloudFront returns an IllegalUpdate
error.
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistribution
request are not merged into the existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, CNAME
), you must specify all
of the values that you want to appear in the updated distribution. In addition, you must update the corresponding
Quantity
element.
Submit an UpdateDistribution
request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an XML
document with a DistributionConfig
element.
Set the value of the HTTP If-Match
header to the value of the ETag
header that
CloudFront returned when you submitted the GetDistributionConfig
request in Step 1.
Review the response to the UpdateDistribution
request to confirm that the configuration was
successfully updated.
Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation
is complete, the value of Status
is Deployed
.
Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML
document that you include in the request body when you create or update a distribution. With previous versions of
the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts
multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to
prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say
you're specifying in the Quantity
element and the number of values you're actually specifying.
UpdateDistributionRequest.Builder
avoiding the
need to create one manually via UpdateDistributionRequest.builder()
updateDistributionRequest
- a Consumer
that will call methods on UpdateDistributionRequest.Builder
.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.RequiredProtocols
element from your
distribution configuration.Origin Id
.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.Quantity
and the size of Items
don't match.default CompletableFuture<UpdateStreamingDistributionResponse> updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
updateStreamingDistributionRequest
- The request to update a streaming distribution.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.Quantity
and the size of Items
don't match.default CompletableFuture<UpdateStreamingDistributionResponse> updateStreamingDistribution(Consumer<UpdateStreamingDistributionRequest.Builder> updateStreamingDistributionRequest)
Update a streaming distribution.
UpdateStreamingDistributionRequest.Builder
avoiding the need to create one manually via UpdateStreamingDistributionRequest.builder()
updateStreamingDistributionRequest
- a Consumer
that will call methods on UpdateStreamingDistributionRequest.Builder
.CallerReference
cannot be updated.If-Match
version is missing or not valid for the
distribution.Content-Type
header is set.false
.Quantity
and the size of Items
don't match.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.