@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static CloudFrontAsyncClient create()
CloudFrontAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudFrontAsyncClientBuilder builder()
CloudFrontAsyncClient
.default CompletableFuture<CreateCachePolicyResponse> createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest)
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests
that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that
matches the request’s cache key. If you want to send values to the origin but not include them in the
cache key, use OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
createCachePolicyRequest
- Quantity
and the size of Items
don't match.UpdateCachePolicy
.default CompletableFuture<CreateCachePolicyResponse> createCachePolicy(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest)
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests
that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that
matches the request’s cache key. If you want to send values to the origin but not include them in the
cache key, use OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateCachePolicyRequest.Builder
avoiding the need
to create one manually via CreateCachePolicyRequest.builder()
createCachePolicyRequest
- A Consumer
that will call methods on CreateCachePolicyRequest.Builder
to create a request.Quantity
and the size of Items
don't match.UpdateCachePolicy
.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 (OAI). An origin access identity is a special
CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of
your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon
CloudFront Developer Guide.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 (OAI). An origin access identity
is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or
just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon
CloudFront Developer Guide.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.
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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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.
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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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<CreateFunctionResponse> createFunction(CreateFunctionRequest createFunctionRequest)
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT
stage. In this stage, you can test the function
with TestFunction
, and update it with UpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use PublishFunction
to copy
the function from the DEVELOPMENT
stage to LIVE
. When it’s live, you can attach the
function to a distribution’s cache behavior, using the function’s ARN.
createFunctionRequest
- UpdateFunction
.default CompletableFuture<CreateFunctionResponse> createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest)
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT
stage. In this stage, you can test the function
with TestFunction
, and update it with UpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use PublishFunction
to copy
the function from the DEVELOPMENT
stage to LIVE
. When it’s live, you can attach the
function to a distribution’s cache behavior, using the function’s ARN.
This is a convenience which creates an instance of the CreateFunctionRequest.Builder
avoiding the need to
create one manually via CreateFunctionRequest.builder()
createFunctionRequest
- A Consumer
that will call methods on CreateFunctionRequest.Builder
to create a request.UpdateFunction
.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<CreateKeyGroupResponse> createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest)
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
createKeyGroupRequest
- UpdateKeyGroup
.default CompletableFuture<CreateKeyGroupResponse> createKeyGroup(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest)
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateKeyGroupRequest.Builder
avoiding the need to
create one manually via CreateKeyGroupRequest.builder()
createKeyGroupRequest
- A Consumer
that will call methods on CreateKeyGroupRequest.Builder
to create a request.UpdateKeyGroup
.default CompletableFuture<CreateMonitoringSubscriptionResponse> createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest)
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
createMonitoringSubscriptionRequest
- default CompletableFuture<CreateMonitoringSubscriptionResponse> createMonitoringSubscription(Consumer<CreateMonitoringSubscriptionRequest.Builder> createMonitoringSubscriptionRequest)
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateMonitoringSubscriptionRequest.Builder
avoiding the need to create one manually via CreateMonitoringSubscriptionRequest.builder()
createMonitoringSubscriptionRequest
- A Consumer
that will call methods on CreateMonitoringSubscriptionRequest.Builder
to create
a request.default CompletableFuture<CreateOriginRequestPolicyResponse> createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest)
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host
,
User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want
to send values to the origin and also include them in the cache key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
createOriginRequestPolicyRequest
- Quantity
and the size of Items
don't match.UpdateOriginRequestPolicy
.default CompletableFuture<CreateOriginRequestPolicyResponse> createOriginRequestPolicy(Consumer<CreateOriginRequestPolicyRequest.Builder> createOriginRequestPolicyRequest)
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host
,
User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want
to send values to the origin and also include them in the cache key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via CreateOriginRequestPolicyRequest.builder()
createOriginRequestPolicyRequest
- A Consumer
that will call methods on CreateOriginRequestPolicyRequest.Builder
to create a
request.Quantity
and the size of Items
don't match.UpdateOriginRequestPolicy
.default CompletableFuture<CreatePublicKeyResponse> createPublicKey(CreatePublicKeyRequest createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
createPublicKeyRequest
- default CompletableFuture<CreatePublicKeyResponse> createPublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
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<CreateRealtimeLogConfigResponse> createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest)
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
createRealtimeLogConfigRequest
- UpdateRealtimeLogConfig
.default CompletableFuture<CreateRealtimeLogConfigResponse> createRealtimeLogConfig(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest)
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via CreateRealtimeLogConfigRequest.builder()
createRealtimeLogConfigRequest
- A Consumer
that will call methods on CreateRealtimeLogConfigRequest.Builder
to create a
request.UpdateRealtimeLogConfig
.default CompletableFuture<CreateStreamingDistributionResponse> createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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)
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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)
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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)
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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<DeleteCachePolicyResponse> deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest)
Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use
ListCachePolicies
or GetCachePolicy
.
deleteCachePolicyRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteCachePolicyResponse> deleteCachePolicy(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest)
Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use
ListCachePolicies
or GetCachePolicy
.
This is a convenience which creates an instance of the DeleteCachePolicyRequest.Builder
avoiding the need
to create one manually via DeleteCachePolicyRequest.builder()
deleteCachePolicyRequest
- A Consumer
that will call methods on DeleteCachePolicyRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.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.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.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.
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.
false
.default CompletableFuture<DeleteFieldLevelEncryptionConfigResponse> deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfigRequest
- If-Match
version is missing or not valid.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.false
.default CompletableFuture<DeleteFieldLevelEncryptionProfileResponse> deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfileRequest
- If-Match
version is missing or not valid.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.false
.default CompletableFuture<DeleteFunctionResponse> deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
deleteFunctionRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteFunctionResponse> deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest)
Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
This is a convenience which creates an instance of the DeleteFunctionRequest.Builder
avoiding the need to
create one manually via DeleteFunctionRequest.builder()
deleteFunctionRequest
- A Consumer
that will call methods on DeleteFunctionRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteKeyGroupResponse> deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest)
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use
ListKeyGroups
followed by GetKeyGroup
or GetKeyGroupConfig
.
deleteKeyGroupRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteKeyGroupResponse> deleteKeyGroup(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest)
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use
ListKeyGroups
followed by GetKeyGroup
or GetKeyGroupConfig
.
This is a convenience which creates an instance of the DeleteKeyGroupRequest.Builder
avoiding the need to
create one manually via DeleteKeyGroupRequest.builder()
deleteKeyGroupRequest
- A Consumer
that will call methods on DeleteKeyGroupRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteMonitoringSubscriptionResponse> deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
deleteMonitoringSubscriptionRequest
- default CompletableFuture<DeleteMonitoringSubscriptionResponse> deleteMonitoringSubscription(Consumer<DeleteMonitoringSubscriptionRequest.Builder> deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
This is a convenience which creates an instance of the DeleteMonitoringSubscriptionRequest.Builder
avoiding the need to create one manually via DeleteMonitoringSubscriptionRequest.builder()
deleteMonitoringSubscriptionRequest
- A Consumer
that will call methods on DeleteMonitoringSubscriptionRequest.Builder
to create
a request.default CompletableFuture<DeleteOriginRequestPolicyResponse> deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest)
Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier,
you can use ListOriginRequestPolicies
or GetOriginRequestPolicy
.
deleteOriginRequestPolicyRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<DeleteOriginRequestPolicyResponse> deleteOriginRequestPolicy(Consumer<DeleteOriginRequestPolicyRequest.Builder> deleteOriginRequestPolicyRequest)
Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier,
you can use ListOriginRequestPolicies
or GetOriginRequestPolicy
.
This is a convenience which creates an instance of the DeleteOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via DeleteOriginRequestPolicyRequest.builder()
deleteOriginRequestPolicyRequest
- A Consumer
that will call methods on DeleteOriginRequestPolicyRequest.Builder
to create a
request.If-Match
version is missing or not valid.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.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.false
.default CompletableFuture<DeleteRealtimeLogConfigResponse> deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest)
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
deleteRealtimeLogConfigRequest
- default CompletableFuture<DeleteRealtimeLogConfigResponse> deleteRealtimeLogConfig(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest)
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
This is a convenience which creates an instance of the DeleteRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via DeleteRealtimeLogConfigRequest.builder()
deleteRealtimeLogConfigRequest
- A Consumer
that will call methods on DeleteRealtimeLogConfigRequest.Builder
to create a
request.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.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.false
.default CompletableFuture<DescribeFunctionResponse> describeFunction(DescribeFunctionRequest describeFunctionRequest)
Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a
function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the function’s name and stage.
To get these values, you can use ListFunctions
.
describeFunctionRequest
- default CompletableFuture<DescribeFunctionResponse> describeFunction(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest)
Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a
function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the function’s name and stage.
To get these values, you can use ListFunctions
.
This is a convenience which creates an instance of the DescribeFunctionRequest.Builder
avoiding the need
to create one manually via DescribeFunctionRequest.builder()
describeFunctionRequest
- A Consumer
that will call methods on DescribeFunctionRequest.Builder
to create a request.default CompletableFuture<GetCachePolicyResponse> getCachePolicy(GetCachePolicyRequest getCachePolicyRequest)
Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a
distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
getCachePolicyRequest
- default CompletableFuture<GetCachePolicyResponse> getCachePolicy(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest)
Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a
distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
This is a convenience which creates an instance of the GetCachePolicyRequest.Builder
avoiding the need to
create one manually via GetCachePolicyRequest.builder()
getCachePolicyRequest
- A Consumer
that will call methods on GetCachePolicyRequest.Builder
to create a request.default CompletableFuture<GetCachePolicyConfigResponse> getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest)
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to
a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
getCachePolicyConfigRequest
- default CompletableFuture<GetCachePolicyConfigResponse> getCachePolicyConfig(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest)
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to
a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
This is a convenience which creates an instance of the GetCachePolicyConfigRequest.Builder
avoiding the
need to create one manually via GetCachePolicyConfigRequest.builder()
getCachePolicyConfigRequest
- A Consumer
that will call methods on GetCachePolicyConfigRequest.Builder
to create a
request.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 CloudFrontOriginAccessIdentityConfig.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 CloudFrontOriginAccessIdentityConfig.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<GetFunctionResponse> getFunction(GetFunctionRequest getFunctionRequest)
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these values, you can use
ListFunctions
.
getFunctionRequest
- default CompletableFuture<GetFunctionResponse> getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest)
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these values, you can use
ListFunctions
.
This is a convenience which creates an instance of the GetFunctionRequest.Builder
avoiding the need to
create one manually via GetFunctionRequest.builder()
getFunctionRequest
- A Consumer
that will call methods on GetFunctionRequest.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<GetKeyGroupResponse> getKeyGroup(GetKeyGroupRequest getKeyGroupRequest)
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a
distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
getKeyGroupRequest
- default CompletableFuture<GetKeyGroupResponse> getKeyGroup(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest)
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a
distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
This is a convenience which creates an instance of the GetKeyGroupRequest.Builder
avoiding the need to
create one manually via GetKeyGroupRequest.builder()
getKeyGroupRequest
- A Consumer
that will call methods on GetKeyGroupRequest.Builder
to create a request.default CompletableFuture<GetKeyGroupConfigResponse> getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest)
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in
a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
getKeyGroupConfigRequest
- default CompletableFuture<GetKeyGroupConfigResponse> getKeyGroupConfig(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest)
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in
a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
This is a convenience which creates an instance of the GetKeyGroupConfigRequest.Builder
avoiding the need
to create one manually via GetKeyGroupConfigRequest.builder()
getKeyGroupConfigRequest
- A Consumer
that will call methods on GetKeyGroupConfigRequest.Builder
to create a request.default CompletableFuture<GetMonitoringSubscriptionResponse> getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
getMonitoringSubscriptionRequest
- default CompletableFuture<GetMonitoringSubscriptionResponse> getMonitoringSubscription(Consumer<GetMonitoringSubscriptionRequest.Builder> getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
This is a convenience which creates an instance of the GetMonitoringSubscriptionRequest.Builder
avoiding
the need to create one manually via GetMonitoringSubscriptionRequest.builder()
getMonitoringSubscriptionRequest
- A Consumer
that will call methods on GetMonitoringSubscriptionRequest.Builder
to create a
request.default CompletableFuture<GetOriginRequestPolicyResponse> getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest)
Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is
attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
getOriginRequestPolicyRequest
- default CompletableFuture<GetOriginRequestPolicyResponse> getOriginRequestPolicy(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest)
Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is
attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
This is a convenience which creates an instance of the GetOriginRequestPolicyRequest.Builder
avoiding the
need to create one manually via GetOriginRequestPolicyRequest.builder()
getOriginRequestPolicyRequest
- A Consumer
that will call methods on GetOriginRequestPolicyRequest.Builder
to create a
request.default CompletableFuture<GetOriginRequestPolicyConfigResponse> getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest)
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request
policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
getOriginRequestPolicyConfigRequest
- default CompletableFuture<GetOriginRequestPolicyConfigResponse> getOriginRequestPolicyConfig(Consumer<GetOriginRequestPolicyConfigRequest.Builder> getOriginRequestPolicyConfigRequest)
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request
policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
This is a convenience which creates an instance of the GetOriginRequestPolicyConfigRequest.Builder
avoiding the need to create one manually via GetOriginRequestPolicyConfigRequest.builder()
getOriginRequestPolicyConfigRequest
- A Consumer
that will call methods on GetOriginRequestPolicyConfigRequest.Builder
to create
a request.default CompletableFuture<GetPublicKeyResponse> getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets a public key.
getPublicKeyRequest
- default CompletableFuture<GetPublicKeyResponse> getPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest)
Gets a public key.
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)
Gets a public key configuration.
getPublicKeyConfigRequest
- default CompletableFuture<GetPublicKeyConfigResponse> getPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest)
Gets a public key configuration.
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<GetRealtimeLogConfigResponse> getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest)
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
getRealtimeLogConfigRequest
- default CompletableFuture<GetRealtimeLogConfigResponse> getRealtimeLogConfig(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest)
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
This is a convenience which creates an instance of the GetRealtimeLogConfigRequest.Builder
avoiding the
need to create one manually via GetRealtimeLogConfigRequest.builder()
getRealtimeLogConfigRequest
- A Consumer
that will call methods on GetRealtimeLogConfigRequest.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<ListCachePoliciesResponse> listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest)
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listCachePoliciesRequest
- default CompletableFuture<ListCachePoliciesResponse> listCachePolicies(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest)
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListCachePoliciesRequest.Builder
avoiding the need
to create one manually via ListCachePoliciesRequest.builder()
listCachePoliciesRequest
- A Consumer
that will call methods on ListCachePoliciesRequest.Builder
to create a request.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 CloudFront distributions.
listDistributionsRequest
- The request to list your distributions.default CompletableFuture<ListDistributionsResponse> listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest)
List CloudFront 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 CloudFront distributions.
default CompletableFuture<ListDistributionsByCachePolicyIdResponse> listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByCachePolicyIdRequest
- default CompletableFuture<ListDistributionsByCachePolicyIdResponse> listDistributionsByCachePolicyId(Consumer<ListDistributionsByCachePolicyIdRequest.Builder> listDistributionsByCachePolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListDistributionsByCachePolicyIdRequest.Builder
avoiding the need to create one manually via ListDistributionsByCachePolicyIdRequest.builder()
listDistributionsByCachePolicyIdRequest
- A Consumer
that will call methods on ListDistributionsByCachePolicyIdRequest.Builder
to
create a request.default CompletableFuture<ListDistributionsByKeyGroupResponse> listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByKeyGroupRequest
- default CompletableFuture<ListDistributionsByKeyGroupResponse> listDistributionsByKeyGroup(Consumer<ListDistributionsByKeyGroupRequest.Builder> listDistributionsByKeyGroupRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListDistributionsByKeyGroupRequest.Builder
avoiding the need to create one manually via ListDistributionsByKeyGroupRequest.builder()
listDistributionsByKeyGroupRequest
- A Consumer
that will call methods on ListDistributionsByKeyGroupRequest.Builder
to create
a request.default CompletableFuture<ListDistributionsByOriginRequestPolicyIdResponse> listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByOriginRequestPolicyIdRequest
- default CompletableFuture<ListDistributionsByOriginRequestPolicyIdResponse> listDistributionsByOriginRequestPolicyId(Consumer<ListDistributionsByOriginRequestPolicyIdRequest.Builder> listDistributionsByOriginRequestPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByOriginRequestPolicyIdRequest.Builder
avoiding the need to create one manually via
ListDistributionsByOriginRequestPolicyIdRequest.builder()
listDistributionsByOriginRequestPolicyIdRequest
- A Consumer
that will call methods on
ListDistributionsByOriginRequestPolicyIdRequest.Builder
to create a request.default CompletableFuture<ListDistributionsByRealtimeLogConfigResponse> listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByRealtimeLogConfigRequest
- default CompletableFuture<ListDistributionsByRealtimeLogConfigResponse> listDistributionsByRealtimeLogConfig(Consumer<ListDistributionsByRealtimeLogConfigRequest.Builder> listDistributionsByRealtimeLogConfigRequest)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByRealtimeLogConfigRequest.Builder
avoiding the need to create one manually via
ListDistributionsByRealtimeLogConfigRequest.builder()
listDistributionsByRealtimeLogConfigRequest
- A Consumer
that will call methods on ListDistributionsByRealtimeLogConfigRequest.Builder
to create a request.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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<ListFunctionsResponse> listFunctions(ListFunctionsRequest listFunctionsRequest)
Gets a list of all CloudFront functions in your AWS account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listFunctionsRequest
- default CompletableFuture<ListFunctionsResponse> listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest)
Gets a list of all CloudFront functions in your AWS account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListFunctionsRequest.Builder
avoiding the need to
create one manually via ListFunctionsRequest.builder()
listFunctionsRequest
- A Consumer
that will call methods on ListFunctionsRequest.Builder
to create a request.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<ListKeyGroupsResponse> listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest)
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listKeyGroupsRequest
- default CompletableFuture<ListKeyGroupsResponse> listKeyGroups(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest)
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListKeyGroupsRequest.Builder
avoiding the need to
create one manually via ListKeyGroupsRequest.builder()
listKeyGroupsRequest
- A Consumer
that will call methods on ListKeyGroupsRequest.Builder
to create a request.default CompletableFuture<ListOriginRequestPoliciesResponse> listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest)
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listOriginRequestPoliciesRequest
- default CompletableFuture<ListOriginRequestPoliciesResponse> listOriginRequestPolicies(Consumer<ListOriginRequestPoliciesRequest.Builder> listOriginRequestPoliciesRequest)
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListOriginRequestPoliciesRequest.Builder
avoiding
the need to create one manually via ListOriginRequestPoliciesRequest.builder()
listOriginRequestPoliciesRequest
- A Consumer
that will call methods on ListOriginRequestPoliciesRequest.Builder
to create a
request.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<ListRealtimeLogConfigsResponse> listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest)
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listRealtimeLogConfigsRequest
- default CompletableFuture<ListRealtimeLogConfigsResponse> listRealtimeLogConfigs(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest)
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListRealtimeLogConfigsRequest.Builder
avoiding the
need to create one manually via ListRealtimeLogConfigsRequest.builder()
listRealtimeLogConfigsRequest
- A Consumer
that will call methods on ListRealtimeLogConfigsRequest.Builder
to create a
request.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<PublishFunctionResponse> publishFunction(PublishFunctionRequest publishFunctionRequest)
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to
LIVE
. This automatically updates all cache behaviors that are using this function to use the newly
published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to a distribution’s
cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
publishFunctionRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<PublishFunctionResponse> publishFunction(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest)
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to
LIVE
. This automatically updates all cache behaviors that are using this function to use the newly
published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to a distribution’s
cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
This is a convenience which creates an instance of the PublishFunctionRequest.Builder
avoiding the need
to create one manually via PublishFunctionRequest.builder()
publishFunctionRequest
- A Consumer
that will call methods on PublishFunctionRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.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<TestFunctionResponse> testFunction(TestFunctionRequest testFunctionRequest)
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function’s name and version (ETag
value) along with the event
object. To get the function’s name and version, you can use ListFunctions
and
DescribeFunction
.
testFunctionRequest
- If-Match
version is missing or not valid.default CompletableFuture<TestFunctionResponse> testFunction(Consumer<TestFunctionRequest.Builder> testFunctionRequest)
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function’s name and version (ETag
value) along with the event
object. To get the function’s name and version, you can use ListFunctions
and
DescribeFunction
.
This is a convenience which creates an instance of the TestFunctionRequest.Builder
avoiding the need to
create one manually via TestFunctionRequest.builder()
testFunctionRequest
- A Consumer
that will call methods on TestFunctionRequest.Builder
to create a request.If-Match
version is missing or not valid.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<UpdateCachePolicyResponse> updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest)
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig
to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that
you modified and those that you didn’t.
updateCachePolicyRequest
- Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.UpdateCachePolicy
.default CompletableFuture<UpdateCachePolicyResponse> updateCachePolicy(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest)
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig
to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that
you modified and those that you didn’t.
This is a convenience which creates an instance of the UpdateCachePolicyRequest.Builder
avoiding the need
to create one manually via UpdateCachePolicyRequest.builder()
updateCachePolicyRequest
- A Consumer
that will call methods on UpdateCachePolicyRequest.Builder
to create a request.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.UpdateCachePolicy
.default CompletableFuture<UpdateCloudFrontOriginAccessIdentityResponse> updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
updateCloudFrontOriginAccessIdentityRequest
- The request to update an origin access identity.If-Match
version is missing or not valid.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.If-Match
version is missing or not valid.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.If-Match
version is missing or not valid.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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.If-Match
version is missing or not valid.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.arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.default CompletableFuture<UpdateFieldLevelEncryptionConfigResponse> updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfigRequest
- Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.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.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.default CompletableFuture<UpdateFieldLevelEncryptionProfileResponse> updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
updateFieldLevelEncryptionProfileRequest
- Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.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.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.default CompletableFuture<UpdateFunctionResponse> updateFunction(UpdateFunctionRequest updateFunctionRequest)
Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag
value) along with the
updated function code. To get the name and version, you can use ListFunctions
and
DescribeFunction
.
updateFunctionRequest
- If-Match
version is missing or not valid.false
.default CompletableFuture<UpdateFunctionResponse> updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest)
Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag
value) along with the
updated function code. To get the name and version, you can use ListFunctions
and
DescribeFunction
.
This is a convenience which creates an instance of the UpdateFunctionRequest.Builder
avoiding the need to
create one manually via UpdateFunctionRequest.builder()
updateFunctionRequest
- A Consumer
that will call methods on UpdateFunctionRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.default CompletableFuture<UpdateKeyGroupResponse> updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest)
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup
or GetKeyGroupConfig
.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup
with the entire key group object, including the fields that you modified and
those that you didn’t.
updateKeyGroupRequest
- If-Match
version is missing or not valid.false
.UpdateKeyGroup
.default CompletableFuture<UpdateKeyGroupResponse> updateKeyGroup(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest)
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup
or GetKeyGroupConfig
.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup
with the entire key group object, including the fields that you modified and
those that you didn’t.
This is a convenience which creates an instance of the UpdateKeyGroupRequest.Builder
avoiding the need to
create one manually via UpdateKeyGroupRequest.builder()
updateKeyGroupRequest
- A Consumer
that will call methods on UpdateKeyGroupRequest.Builder
to create a request.If-Match
version is missing or not valid.false
.UpdateKeyGroup
.default CompletableFuture<UpdateOriginRequestPolicyResponse> updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest)
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig
to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy
by providing the entire origin request policy configuration,
including the fields that you modified and those that you didn’t.
updateOriginRequestPolicyRequest
- Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.UpdateOriginRequestPolicy
.default CompletableFuture<UpdateOriginRequestPolicyResponse> updateOriginRequestPolicy(Consumer<UpdateOriginRequestPolicyRequest.Builder> updateOriginRequestPolicyRequest)
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig
to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy
by providing the entire origin request policy configuration,
including the fields that you modified and those that you didn’t.
This is a convenience which creates an instance of the UpdateOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via UpdateOriginRequestPolicyRequest.builder()
updateOriginRequestPolicyRequest
- A Consumer
that will call methods on UpdateOriginRequestPolicyRequest.Builder
to create a
request.Quantity
and the size of Items
don't match.If-Match
version is missing or not valid.false
.UpdateOriginRequestPolicy
.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.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.false
.default CompletableFuture<UpdateRealtimeLogConfigResponse> updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest)
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig
to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig
) by providing the entire real-time log configuration,
including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name
or ARN
.
updateRealtimeLogConfigRequest
- default CompletableFuture<UpdateRealtimeLogConfigResponse> updateRealtimeLogConfig(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest)
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig
to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig
) by providing the entire real-time log configuration,
including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name
or ARN
.
This is a convenience which creates an instance of the UpdateRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via UpdateRealtimeLogConfigRequest.builder()
updateRealtimeLogConfigRequest
- A Consumer
that will call methods on UpdateRealtimeLogConfigRequest.Builder
to create a
request.default CompletableFuture<UpdateStreamingDistributionResponse> updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
updateStreamingDistributionRequest
- The request to update a streaming distribution.If-Match
version is missing or not valid.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.If-Match
version is missing or not valid.Content-Type
header is set.false
.Quantity
and the size of Items
don't match.default CloudFrontAsyncWaiter waiter()
CloudFrontAsyncWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudFrontAsyncWaiter
Copyright © 2021. All rights reserved.