@Generated(value="software.amazon.awssdk:codegen") public interface CloudFrontAsyncClient extends SdkClient
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.
This is a convenience which creates an instance of the
CreateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
CreateCloudFrontOriginAccessIdentityRequest.builder()
createCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on CreateCloudFrontOriginAccessIdentityRequest.Builder
to create a request. 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<CreateDistributionResponse> createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to
be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the /CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.
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. You create a CloudFront distribution to tell CloudFront where you want content to
be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the /CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.
This is a convenience which creates an instance of the CreateDistributionRequest.Builder
avoiding the
need to create one manually via CreateDistributionRequest.builder()
createDistributionRequest
- A Consumer
that will call methods on CreateDistributionRequest.Builder
to create a
request. 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<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.
This is a convenience which creates an instance of the CreateDistributionWithTagsRequest.Builder
avoiding
the need to create one manually via CreateDistributionWithTagsRequest.builder()
createDistributionWithTagsRequest
- A Consumer
that will call methods on CreateDistributionWithTagsRequest.Builder
to create a
request. 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<CreateFieldLevelEncryptionConfigResponse> createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
createFieldLevelEncryptionConfigRequest
- Quantity
and the size of Items
don't match.default CompletableFuture<CreateFieldLevelEncryptionConfigResponse> createFieldLevelEncryptionConfig(Consumer<CreateFieldLevelEncryptionConfigRequest.Builder> createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
This is a convenience which creates an instance of the CreateFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via CreateFieldLevelEncryptionConfigRequest.builder()
createFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on CreateFieldLevelEncryptionConfigRequest.Builder
to
create a request.Quantity
and the size of Items
don't match.default CompletableFuture<CreateFieldLevelEncryptionProfileResponse> createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
createFieldLevelEncryptionProfileRequest
- Quantity
and the size of Items
don't match.default CompletableFuture<CreateFieldLevelEncryptionProfileResponse> createFieldLevelEncryptionProfile(Consumer<CreateFieldLevelEncryptionProfileRequest.Builder> createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
This is a convenience which creates an instance of the CreateFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via CreateFieldLevelEncryptionProfileRequest.builder()
createFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on CreateFieldLevelEncryptionProfileRequest.Builder
to
create a request.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.
This is a convenience which creates an instance of the CreateInvalidationRequest.Builder
avoiding the
need to create one manually via CreateInvalidationRequest.builder()
createInvalidationRequest
- A Consumer
that will call methods on CreateInvalidationRequest.Builder
to create a
request. The request to create an invalidation.Content-Type
header is set.Quantity
and the size of Items
don't match.default CompletableFuture<CreatePublicKeyResponse> createPublicKey(CreatePublicKeyRequest createPublicKeyRequest)
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
createPublicKeyRequest
- default CompletableFuture<CreatePublicKeyResponse> createPublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest)
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
This is a convenience which creates an instance of the CreatePublicKeyRequest.Builder
avoiding the need
to create one manually via CreatePublicKeyRequest.builder()
createPublicKeyRequest
- A Consumer
that will call methods on CreatePublicKeyRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the CreateStreamingDistributionRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionRequest.builder()
createStreamingDistributionRequest
- A Consumer
that will call methods on CreateStreamingDistributionRequest.Builder
to create
a request. The request to create a new streaming distribution.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.
This is a convenience which creates an instance of the CreateStreamingDistributionWithTagsRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionWithTagsRequest.builder()
createStreamingDistributionWithTagsRequest
- A Consumer
that will call methods on CreateStreamingDistributionWithTagsRequest.Builder
to
create a request. 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<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.
This is a convenience which creates an instance of the
DeleteCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
DeleteCloudFrontOriginAccessIdentityRequest.builder()
deleteCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on DeleteCloudFrontOriginAccessIdentityRequest.Builder
to create a request. Deletes a origin access identity.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.
This is a convenience which creates an instance of the DeleteDistributionRequest.Builder
avoiding the
need to create one manually via DeleteDistributionRequest.builder()
deleteDistributionRequest
- A Consumer
that will call methods on DeleteDistributionRequest.Builder
to create a
request. 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<DeleteFieldLevelEncryptionConfigResponse> deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfigRequest
- If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteFieldLevelEncryptionConfigResponse> deleteFieldLevelEncryptionConfig(Consumer<DeleteFieldLevelEncryptionConfigRequest.Builder> deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
This is a convenience which creates an instance of the DeleteFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via DeleteFieldLevelEncryptionConfigRequest.builder()
deleteFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on DeleteFieldLevelEncryptionConfigRequest.Builder
to
create a request.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteFieldLevelEncryptionProfileResponse> deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfileRequest
- If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeleteFieldLevelEncryptionProfileResponse> deleteFieldLevelEncryptionProfile(Consumer<DeleteFieldLevelEncryptionProfileRequest.Builder> deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
This is a convenience which creates an instance of the DeleteFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via DeleteFieldLevelEncryptionProfileRequest.builder()
deleteFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on DeleteFieldLevelEncryptionProfileRequest.Builder
to
create a request.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeletePublicKeyResponse> deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
deletePublicKeyRequest
- If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<DeletePublicKeyResponse> deletePublicKey(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
This is a convenience which creates an instance of the DeletePublicKeyRequest.Builder
avoiding the need
to create one manually via DeletePublicKeyRequest.builder()
deletePublicKeyRequest
- A Consumer
that will call methods on DeletePublicKeyRequest.Builder
to create a request.If-Match
version is missing or not valid for the
distribution.false
.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.
This is a convenience which creates an instance of the DeleteStreamingDistributionRequest.Builder
avoiding the need to create one manually via DeleteStreamingDistributionRequest.builder()
deleteStreamingDistributionRequest
- A Consumer
that will call methods on DeleteStreamingDistributionRequest.Builder
to create
a request. The request to delete a streaming distribution.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.
This is a convenience which creates an instance of the GetCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via GetCloudFrontOriginAccessIdentityRequest.builder()
getCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on GetCloudFrontOriginAccessIdentityRequest.Builder
to
create a request. The request to get an origin access identity's information.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.
This is a convenience which creates an instance of the
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
avoiding the need to create one manually via
GetCloudFrontOriginAccessIdentityConfigRequest.builder()
getCloudFrontOriginAccessIdentityConfigRequest
- A Consumer
that will call methods on
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
to create a request. The origin access
identity's configuration information. For more information, see
CloudFrontOriginAccessIdentityConfigComplexType.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.
This is a convenience which creates an instance of the GetDistributionRequest.Builder
avoiding the need
to create one manually via GetDistributionRequest.builder()
getDistributionRequest
- A Consumer
that will call methods on GetDistributionRequest.Builder
to create a request.
The request to get a distribution's information.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.
This is a convenience which creates an instance of the GetDistributionConfigRequest.Builder
avoiding the
need to create one manually via GetDistributionConfigRequest.builder()
getDistributionConfigRequest
- A Consumer
that will call methods on GetDistributionConfigRequest.Builder
to create a
request. The request to get a distribution configuration.default CompletableFuture<GetFieldLevelEncryptionResponse> getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
getFieldLevelEncryptionRequest
- default CompletableFuture<GetFieldLevelEncryptionResponse> getFieldLevelEncryption(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionRequest.Builder
avoiding
the need to create one manually via GetFieldLevelEncryptionRequest.builder()
getFieldLevelEncryptionRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionRequest.Builder
to create a
request.default CompletableFuture<GetFieldLevelEncryptionConfigResponse> getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfigRequest
- default CompletableFuture<GetFieldLevelEncryptionConfigResponse> getFieldLevelEncryptionConfig(Consumer<GetFieldLevelEncryptionConfigRequest.Builder> getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via GetFieldLevelEncryptionConfigRequest.builder()
getFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionConfigRequest.Builder
to
create a request.default CompletableFuture<GetFieldLevelEncryptionProfileResponse> getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
getFieldLevelEncryptionProfileRequest
- default CompletableFuture<GetFieldLevelEncryptionProfileResponse> getFieldLevelEncryptionProfile(Consumer<GetFieldLevelEncryptionProfileRequest.Builder> getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via GetFieldLevelEncryptionProfileRequest.builder()
getFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionProfileRequest.Builder
to
create a request.default CompletableFuture<GetFieldLevelEncryptionProfileConfigResponse> getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfigRequest
- default CompletableFuture<GetFieldLevelEncryptionProfileConfigResponse> getFieldLevelEncryptionProfileConfig(Consumer<GetFieldLevelEncryptionProfileConfigRequest.Builder> getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionProfileConfigRequest.Builder
avoiding the need to create one manually via
GetFieldLevelEncryptionProfileConfigRequest.builder()
getFieldLevelEncryptionProfileConfigRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionProfileConfigRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the GetInvalidationRequest.Builder
avoiding the need
to create one manually via GetInvalidationRequest.builder()
getInvalidationRequest
- A Consumer
that will call methods on GetInvalidationRequest.Builder
to create a request.
The request to get an invalidation's information.default CompletableFuture<GetPublicKeyResponse> getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Get the public key information.
getPublicKeyRequest
- default CompletableFuture<GetPublicKeyResponse> getPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest)
Get the public key information.
This is a convenience which creates an instance of the GetPublicKeyRequest.Builder
avoiding the need to
create one manually via GetPublicKeyRequest.builder()
getPublicKeyRequest
- A Consumer
that will call methods on GetPublicKeyRequest.Builder
to create a request.default CompletableFuture<GetPublicKeyConfigResponse> getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest)
Return public key configuration informaation
getPublicKeyConfigRequest
- default CompletableFuture<GetPublicKeyConfigResponse> getPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest)
Return public key configuration informaation
This is a convenience which creates an instance of the GetPublicKeyConfigRequest.Builder
avoiding the
need to create one manually via GetPublicKeyConfigRequest.builder()
getPublicKeyConfigRequest
- A Consumer
that will call methods on GetPublicKeyConfigRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the GetStreamingDistributionRequest.Builder
avoiding
the need to create one manually via GetStreamingDistributionRequest.builder()
getStreamingDistributionRequest
- A Consumer
that will call methods on GetStreamingDistributionRequest.Builder
to create a
request. The request to get a streaming distribution's information.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.
This is a convenience which creates an instance of the GetStreamingDistributionConfigRequest.Builder
avoiding the need to create one manually via GetStreamingDistributionConfigRequest.builder()
getStreamingDistributionConfigRequest
- A Consumer
that will call methods on GetStreamingDistributionConfigRequest.Builder
to
create a request. To request to get a streaming distribution configuration.default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest
- The request to list origin access identities.default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
This is a convenience which creates an instance of the
ListCloudFrontOriginAccessIdentitiesRequest.Builder
avoiding the need to create one manually via
ListCloudFrontOriginAccessIdentitiesRequest.builder()
listCloudFrontOriginAccessIdentitiesRequest
- A Consumer
that will call methods on ListCloudFrontOriginAccessIdentitiesRequest.Builder
to create a request. The request to list origin access identities.default CompletableFuture<ListCloudFrontOriginAccessIdentitiesResponse> listCloudFrontOriginAccessIdentities()
Lists origin access identities.
default CompletableFuture<ListDistributionsResponse> listDistributions(ListDistributionsRequest listDistributionsRequest)
List distributions.
listDistributionsRequest
- The request to list your distributions.default CompletableFuture<ListDistributionsResponse> listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest)
List distributions.
This is a convenience which creates an instance of the ListDistributionsRequest.Builder
avoiding the need
to create one manually via ListDistributionsRequest.builder()
listDistributionsRequest
- A Consumer
that will call methods on ListDistributionsRequest.Builder
to create a request.
The request to list your distributions.default CompletableFuture<ListDistributionsResponse> listDistributions()
List distributions.
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.
This is a convenience which creates an instance of the ListDistributionsByWebAclIdRequest.Builder
avoiding the need to create one manually via ListDistributionsByWebAclIdRequest.builder()
listDistributionsByWebAclIdRequest
- A Consumer
that will call methods on ListDistributionsByWebACLIdRequest.Builder
to create
a request. The request to list distributions that are associated with a specified AWS WAF web ACL.default CompletableFuture<ListFieldLevelEncryptionConfigsResponse> listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigsRequest
- default CompletableFuture<ListFieldLevelEncryptionConfigsResponse> listFieldLevelEncryptionConfigs(Consumer<ListFieldLevelEncryptionConfigsRequest.Builder> listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
This is a convenience which creates an instance of the ListFieldLevelEncryptionConfigsRequest.Builder
avoiding the need to create one manually via ListFieldLevelEncryptionConfigsRequest.builder()
listFieldLevelEncryptionConfigsRequest
- A Consumer
that will call methods on ListFieldLevelEncryptionConfigsRequest.Builder
to
create a request.default CompletableFuture<ListFieldLevelEncryptionConfigsResponse> listFieldLevelEncryptionConfigs()
List all field-level encryption configurations that have been created in CloudFront for this account.
default CompletableFuture<ListFieldLevelEncryptionProfilesResponse> listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfilesRequest
- default CompletableFuture<ListFieldLevelEncryptionProfilesResponse> listFieldLevelEncryptionProfiles(Consumer<ListFieldLevelEncryptionProfilesRequest.Builder> listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
This is a convenience which creates an instance of the ListFieldLevelEncryptionProfilesRequest.Builder
avoiding the need to create one manually via ListFieldLevelEncryptionProfilesRequest.builder()
listFieldLevelEncryptionProfilesRequest
- A Consumer
that will call methods on ListFieldLevelEncryptionProfilesRequest.Builder
to
create a request.default CompletableFuture<ListFieldLevelEncryptionProfilesResponse> listFieldLevelEncryptionProfiles()
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
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.
This is a convenience which creates an instance of the ListInvalidationsRequest.Builder
avoiding the need
to create one manually via ListInvalidationsRequest.builder()
listInvalidationsRequest
- A Consumer
that will call methods on ListInvalidationsRequest.Builder
to create a request.
The request to list invalidations.default CompletableFuture<ListPublicKeysResponse> listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
listPublicKeysRequest
- default CompletableFuture<ListPublicKeysResponse> listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
This is a convenience which creates an instance of the ListPublicKeysRequest.Builder
avoiding the need to
create one manually via ListPublicKeysRequest.builder()
listPublicKeysRequest
- A Consumer
that will call methods on ListPublicKeysRequest.Builder
to create a request.default CompletableFuture<ListPublicKeysResponse> listPublicKeys()
List all public keys that have been added to CloudFront for this account.
default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
listStreamingDistributionsRequest
- The request to list your streaming distributions.default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest)
List streaming distributions.
This is a convenience which creates an instance of the ListStreamingDistributionsRequest.Builder
avoiding
the need to create one manually via ListStreamingDistributionsRequest.builder()
listStreamingDistributionsRequest
- A Consumer
that will call methods on ListStreamingDistributionsRequest.Builder
to create a
request. The request to list your streaming distributions.default CompletableFuture<ListStreamingDistributionsResponse> listStreamingDistributions()
List streaming distributions.
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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request. The request to list tags for a CloudFront resource.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.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request. The
request to add tags to a CloudFront resource.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.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request. The
request to remove tags from a CloudFront resource.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.
This is a convenience which creates an instance of the
UpdateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
UpdateCloudFrontOriginAccessIdentityRequest.builder()
updateCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on UpdateCloudFrontOriginAccessIdentityRequest.Builder
to create a request. 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<UpdateDistributionResponse> updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution
request to make the
updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution 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 must get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
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 your 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
.
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.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution
request to make the
updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution 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 must get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
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 your 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
.
This is a convenience which creates an instance of the UpdateDistributionRequest.Builder
avoiding the
need to create one manually via UpdateDistributionRequest.builder()
updateDistributionRequest
- A Consumer
that will call methods on UpdateDistributionRequest.Builder
to create a
request. 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<UpdateFieldLevelEncryptionConfigResponse> updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfigRequest
- CallerReference
cannot be updated.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<UpdateFieldLevelEncryptionConfigResponse> updateFieldLevelEncryptionConfig(Consumer<UpdateFieldLevelEncryptionConfigRequest.Builder> updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
This is a convenience which creates an instance of the UpdateFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via UpdateFieldLevelEncryptionConfigRequest.builder()
updateFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on UpdateFieldLevelEncryptionConfigRequest.Builder
to
create a request.CallerReference
cannot be updated.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<UpdateFieldLevelEncryptionProfileResponse> updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
updateFieldLevelEncryptionProfileRequest
- CallerReference
cannot be updated.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<UpdateFieldLevelEncryptionProfileResponse> updateFieldLevelEncryptionProfile(Consumer<UpdateFieldLevelEncryptionProfileRequest.Builder> updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
This is a convenience which creates an instance of the UpdateFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via UpdateFieldLevelEncryptionProfileRequest.builder()
updateFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on UpdateFieldLevelEncryptionProfileRequest.Builder
to
create a request.CallerReference
cannot be updated.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid for the
distribution.false
.default CompletableFuture<UpdatePublicKeyResponse> updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest)
Update public key information. Note that the only value you can change is the comment.
updatePublicKeyRequest
- If-Match
version is missing or not valid for the
distribution.CallerReference
cannot be updated.false
.default CompletableFuture<UpdatePublicKeyResponse> updatePublicKey(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest)
Update public key information. Note that the only value you can change is the comment.
This is a convenience which creates an instance of the UpdatePublicKeyRequest.Builder
avoiding the need
to create one manually via UpdatePublicKeyRequest.builder()
updatePublicKeyRequest
- A Consumer
that will call methods on UpdatePublicKeyRequest.Builder
to create a request.If-Match
version is missing or not valid for the
distribution.CallerReference
cannot be updated.false
.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.
This is a convenience which creates an instance of the UpdateStreamingDistributionRequest.Builder
avoiding the need to create one manually via UpdateStreamingDistributionRequest.builder()
updateStreamingDistributionRequest
- A Consumer
that will call methods on UpdateStreamingDistributionRequest.Builder
to create
a request. 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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.