@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudFront extends Object implements AmazonCloudFront
AmazonCloudFront
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public void setEndpoint(String endpoint)
AmazonCloudFront
Callers can pass in just the endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol
(ex: "https://cloudfront.amazonaws.com/"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonCloudFront
endpoint
- The endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol (ex:
"https://cloudfront.amazonaws.com/") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonCloudFront
AmazonCloudFront.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonCloudFront
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssociateAliasResult associateAlias(AssociateAliasRequest request)
AmazonCloudFront
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
associateAlias
in interface AmazonCloudFront
public CopyDistributionResult copyDistribution(CopyDistributionRequest request)
AmazonCloudFront
Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use UpdateDistribution
to modify the staging
distribution's configuration. Then you can use CreateContinuousDeploymentPolicy
to incrementally
move traffic to the staging distribution.
This API operation requires the following IAM permissions:
copyDistribution
in interface AmazonCloudFront
public CreateCachePolicyResult createCachePolicy(CreateCachePolicyRequest request)
AmazonCloudFront
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 also 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.
createCachePolicy
in interface AmazonCloudFront
public CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest request)
AmazonCloudFront
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.
createCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
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.public CreateContinuousDeploymentPolicyResult createContinuousDeploymentPolicy(CreateContinuousDeploymentPolicyRequest request)
AmazonCloudFront
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution
to create a staging distribution,
then use UpdateDistribution
to modify the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
createContinuousDeploymentPolicy
in interface AmazonCloudFront
public CreateDistributionResult createDistribution(CreateDistributionRequest request)
AmazonCloudFront
Creates a CloudFront distribution.
createDistribution
in interface AmazonCloudFront
request
- The request to create a new distribution.public CreateDistributionWithTagsResult createDistributionWithTags(CreateDistributionWithTagsRequest request)
AmazonCloudFront
Create a new distribution with tags. This API operation requires the following IAM permissions:
createDistributionWithTags
in interface AmazonCloudFront
request
- The request to create a new distribution with tags.public CreateFieldLevelEncryptionConfigResult createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest request)
AmazonCloudFront
Create a new field-level encryption configuration.
createFieldLevelEncryptionConfig
in interface AmazonCloudFront
public CreateFieldLevelEncryptionProfileResult createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest request)
AmazonCloudFront
Create a field-level encryption profile.
createFieldLevelEncryptionProfile
in interface AmazonCloudFront
public CreateFunctionResult createFunction(CreateFunctionRequest request)
AmazonCloudFront
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.
createFunction
in interface AmazonCloudFront
public CreateInvalidationResult createInvalidation(CreateInvalidationRequest request)
AmazonCloudFront
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
createInvalidation
in interface AmazonCloudFront
request
- The request to create an invalidation.public CreateKeyGroupResult createKeyGroup(CreateKeyGroupRequest request)
AmazonCloudFront
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.
createKeyGroup
in interface AmazonCloudFront
public CreateKeyValueStoreResult createKeyValueStore(CreateKeyValueStoreRequest request)
AmazonCloudFront
Specifies the key value store resource to add to your account. In your account, the key value store names must be
unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid
ImportSource
that you own.
createKeyValueStore
in interface AmazonCloudFront
public CreateMonitoringSubscriptionResult createMonitoringSubscription(CreateMonitoringSubscriptionRequest request)
AmazonCloudFront
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.
createMonitoringSubscription
in interface AmazonCloudFront
public CreateOriginAccessControlResult createOriginAccessControl(CreateOriginAccessControlRequest request)
AmazonCloudFront
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
createOriginAccessControl
in interface AmazonCloudFront
public CreateOriginRequestPolicyResult createOriginRequestPolicy(CreateOriginRequestPolicyRequest request)
AmazonCloudFront
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.
createOriginRequestPolicy
in interface AmazonCloudFront
public CreatePublicKeyResult createPublicKey(CreatePublicKeyRequest request)
AmazonCloudFront
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
createPublicKey
in interface AmazonCloudFront
public CreateRealtimeLogConfigResult createRealtimeLogConfig(CreateRealtimeLogConfigRequest request)
AmazonCloudFront
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.
createRealtimeLogConfig
in interface AmazonCloudFront
public CreateResponseHeadersPolicyResult createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest request)
AmazonCloudFront
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
createResponseHeadersPolicy
in interface AmazonCloudFront
public CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest request)
AmazonCloudFront
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.
createStreamingDistribution
in interface AmazonCloudFront
request
- The request to create a new streaming distribution.public CreateStreamingDistributionWithTagsResult createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest request)
AmazonCloudFront
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.
createStreamingDistributionWithTags
in interface AmazonCloudFront
request
- The request to create a new streaming distribution with tags.public DeleteCachePolicyResult deleteCachePolicy(DeleteCachePolicyRequest request)
AmazonCloudFront
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
.
deleteCachePolicy
in interface AmazonCloudFront
public DeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest request)
AmazonCloudFront
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
request
- Deletes a origin access identity.public DeleteContinuousDeploymentPolicyResult deleteContinuousDeploymentPolicy(DeleteContinuousDeploymentPolicyRequest request)
AmazonCloudFront
Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
deleteContinuousDeploymentPolicy
in interface AmazonCloudFront
public DeleteDistributionResult deleteDistribution(DeleteDistributionRequest request)
AmazonCloudFront
Delete a distribution.
deleteDistribution
in interface AmazonCloudFront
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.
public DeleteFieldLevelEncryptionConfigResult deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest request)
AmazonCloudFront
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfig
in interface AmazonCloudFront
public DeleteFieldLevelEncryptionProfileResult deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest request)
AmazonCloudFront
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfile
in interface AmazonCloudFront
public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
AmazonCloudFront
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
.
deleteFunction
in interface AmazonCloudFront
public DeleteKeyGroupResult deleteKeyGroup(DeleteKeyGroupRequest request)
AmazonCloudFront
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
.
deleteKeyGroup
in interface AmazonCloudFront
public DeleteKeyValueStoreResult deleteKeyValueStore(DeleteKeyValueStoreRequest request)
AmazonCloudFront
Specifies the key value store to delete.
deleteKeyValueStore
in interface AmazonCloudFront
public DeleteMonitoringSubscriptionResult deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest request)
AmazonCloudFront
Disables additional CloudWatch metrics for the specified CloudFront distribution.
deleteMonitoringSubscription
in interface AmazonCloudFront
public DeleteOriginAccessControlResult deleteOriginAccessControl(DeleteOriginAccessControlRequest request)
AmazonCloudFront
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
deleteOriginAccessControl
in interface AmazonCloudFront
public DeleteOriginRequestPolicyResult deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest request)
AmazonCloudFront
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
.
deleteOriginRequestPolicy
in interface AmazonCloudFront
public DeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest request)
AmazonCloudFront
Remove a public key you previously added to CloudFront.
deletePublicKey
in interface AmazonCloudFront
public DeleteRealtimeLogConfigResult deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest request)
AmazonCloudFront
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.
deleteRealtimeLogConfig
in interface AmazonCloudFront
public DeleteResponseHeadersPolicyResult deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest request)
AmazonCloudFront
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values,
you can use ListResponseHeadersPolicies
or GetResponseHeadersPolicy
.
deleteResponseHeadersPolicy
in interface AmazonCloudFront
public DeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest request)
AmazonCloudFront
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.
deleteStreamingDistribution
in interface AmazonCloudFront
request
- The request to delete a streaming distribution.public DescribeFunctionResult describeFunction(DescribeFunctionRequest request)
AmazonCloudFront
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
.
describeFunction
in interface AmazonCloudFront
public DescribeKeyValueStoreResult describeKeyValueStore(DescribeKeyValueStoreRequest request)
AmazonCloudFront
Specifies the key value store and its configuration.
describeKeyValueStore
in interface AmazonCloudFront
public GetCachePolicyResult getCachePolicy(GetCachePolicyRequest request)
AmazonCloudFront
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
.
getCachePolicy
in interface AmazonCloudFront
public GetCachePolicyConfigResult getCachePolicyConfig(GetCachePolicyConfigRequest request)
AmazonCloudFront
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
.
getCachePolicyConfig
in interface AmazonCloudFront
public GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest request)
AmazonCloudFront
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
request
- The request to get an origin access identity's information.public GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest request)
AmazonCloudFront
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfig
in interface AmazonCloudFront
request
- The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.public GetContinuousDeploymentPolicyResult getContinuousDeploymentPolicy(GetContinuousDeploymentPolicyRequest request)
AmazonCloudFront
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
getContinuousDeploymentPolicy
in interface AmazonCloudFront
public GetContinuousDeploymentPolicyConfigResult getContinuousDeploymentPolicyConfig(GetContinuousDeploymentPolicyConfigRequest request)
AmazonCloudFront
Gets configuration information about a continuous deployment policy.
getContinuousDeploymentPolicyConfig
in interface AmazonCloudFront
public GetDistributionResult getDistribution(GetDistributionRequest request)
AmazonCloudFront
Get the information about a distribution.
getDistribution
in interface AmazonCloudFront
request
- The request to get a distribution's information.public GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest request)
AmazonCloudFront
Get the configuration information about a distribution.
getDistributionConfig
in interface AmazonCloudFront
request
- The request to get a distribution configuration.public GetFieldLevelEncryptionResult getFieldLevelEncryption(GetFieldLevelEncryptionRequest request)
AmazonCloudFront
Get the field-level encryption configuration information.
getFieldLevelEncryption
in interface AmazonCloudFront
public GetFieldLevelEncryptionConfigResult getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest request)
AmazonCloudFront
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfig
in interface AmazonCloudFront
public GetFieldLevelEncryptionProfileResult getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest request)
AmazonCloudFront
Get the field-level encryption profile information.
getFieldLevelEncryptionProfile
in interface AmazonCloudFront
public GetFieldLevelEncryptionProfileConfigResult getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest request)
AmazonCloudFront
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfig
in interface AmazonCloudFront
public GetFunctionResult getFunction(GetFunctionRequest request)
AmazonCloudFront
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
.
getFunction
in interface AmazonCloudFront
public GetInvalidationResult getInvalidation(GetInvalidationRequest request)
AmazonCloudFront
Get the information about an invalidation.
getInvalidation
in interface AmazonCloudFront
request
- The request to get an invalidation's information.public GetKeyGroupResult getKeyGroup(GetKeyGroupRequest request)
AmazonCloudFront
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
.
getKeyGroup
in interface AmazonCloudFront
public GetKeyGroupConfigResult getKeyGroupConfig(GetKeyGroupConfigRequest request)
AmazonCloudFront
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
.
getKeyGroupConfig
in interface AmazonCloudFront
public GetMonitoringSubscriptionResult getMonitoringSubscription(GetMonitoringSubscriptionRequest request)
AmazonCloudFront
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
getMonitoringSubscription
in interface AmazonCloudFront
public GetOriginAccessControlResult getOriginAccessControl(GetOriginAccessControlRequest request)
AmazonCloudFront
Gets a CloudFront origin access control, including its unique identifier.
getOriginAccessControl
in interface AmazonCloudFront
public GetOriginAccessControlConfigResult getOriginAccessControlConfig(GetOriginAccessControlConfigRequest request)
AmazonCloudFront
Gets a CloudFront origin access control configuration.
getOriginAccessControlConfig
in interface AmazonCloudFront
public GetOriginRequestPolicyResult getOriginRequestPolicy(GetOriginRequestPolicyRequest request)
AmazonCloudFront
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
.
getOriginRequestPolicy
in interface AmazonCloudFront
public GetOriginRequestPolicyConfigResult getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest request)
AmazonCloudFront
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
.
getOriginRequestPolicyConfig
in interface AmazonCloudFront
public GetPublicKeyResult getPublicKey(GetPublicKeyRequest request)
AmazonCloudFront
Gets a public key.
getPublicKey
in interface AmazonCloudFront
public GetPublicKeyConfigResult getPublicKeyConfig(GetPublicKeyConfigRequest request)
AmazonCloudFront
Gets a public key configuration.
getPublicKeyConfig
in interface AmazonCloudFront
public GetRealtimeLogConfigResult getRealtimeLogConfig(GetRealtimeLogConfigRequest request)
AmazonCloudFront
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.
getRealtimeLogConfig
in interface AmazonCloudFront
public GetResponseHeadersPolicyResult getResponseHeadersPolicy(GetResponseHeadersPolicyRequest request)
AmazonCloudFront
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is
attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
or GetDistribution
. If the response headers policy is not attached to
a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
getResponseHeadersPolicy
in interface AmazonCloudFront
public GetResponseHeadersPolicyConfigResult getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest request)
AmazonCloudFront
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers
policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
or GetDistribution
. If the response headers policy is not attached to
a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
getResponseHeadersPolicyConfig
in interface AmazonCloudFront
public GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest request)
AmazonCloudFront
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistribution
in interface AmazonCloudFront
request
- The request to get a streaming distribution's information.public GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest request)
AmazonCloudFront
Get the configuration information about a streaming distribution.
getStreamingDistributionConfig
in interface AmazonCloudFront
request
- To request to get a streaming distribution configuration.public ListCachePoliciesResult listCachePolicies(ListCachePoliciesRequest request)
AmazonCloudFront
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listCachePolicies
in interface AmazonCloudFront
public ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest request)
AmazonCloudFront
Lists origin access identities.
listCloudFrontOriginAccessIdentities
in interface AmazonCloudFront
request
- The request to list origin access identities.public ListConflictingAliasesResult listConflictingAliases(ListConflictingAliasesRequest request)
AmazonCloudFront
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided
alias. For example, if you provide www.example.com
as input, the returned list can include
www.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if
they exist. If you provide *.example.com
as input, the returned list can include
*.example.com
and any alternate domain names covered by that wildcard (for example,
www.example.com
, test.example.com
, dev.example.com
, and so on), if they
exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
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.
listConflictingAliases
in interface AmazonCloudFront
public ListContinuousDeploymentPoliciesResult listContinuousDeploymentPolicies(ListContinuousDeploymentPoliciesRequest request)
AmazonCloudFront
Gets a list of the continuous deployment policies in your Amazon Web Services 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.
listContinuousDeploymentPolicies
in interface AmazonCloudFront
public ListDistributionsResult listDistributions(ListDistributionsRequest request)
AmazonCloudFront
List CloudFront distributions.
listDistributions
in interface AmazonCloudFront
request
- The request to list your distributions.public ListDistributionsByCachePolicyIdResult listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest request)
AmazonCloudFront
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.
listDistributionsByCachePolicyId
in interface AmazonCloudFront
public ListDistributionsByKeyGroupResult listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest request)
AmazonCloudFront
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.
listDistributionsByKeyGroup
in interface AmazonCloudFront
public ListDistributionsByOriginRequestPolicyIdResult listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest request)
AmazonCloudFront
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.
listDistributionsByOriginRequestPolicyId
in interface AmazonCloudFront
public ListDistributionsByRealtimeLogConfigResult listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest request)
AmazonCloudFront
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.
listDistributionsByRealtimeLogConfig
in interface AmazonCloudFront
public ListDistributionsByResponseHeadersPolicyIdResult listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest request)
AmazonCloudFront
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers 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.
listDistributionsByResponseHeadersPolicyId
in interface AmazonCloudFront
public ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest request)
AmazonCloudFront
List the distributions that are associated with a specified WAF web ACL.
listDistributionsByWebACLId
in interface AmazonCloudFront
request
- The request to list distributions that are associated with a specified WAF web ACL.public ListFieldLevelEncryptionConfigsResult listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest request)
AmazonCloudFront
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigs
in interface AmazonCloudFront
public ListFieldLevelEncryptionProfilesResult listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest request)
AmazonCloudFront
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfiles
in interface AmazonCloudFront
public ListFunctionsResult listFunctions(ListFunctionsRequest request)
AmazonCloudFront
Gets a list of all CloudFront functions in your Amazon Web Services 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.
listFunctions
in interface AmazonCloudFront
public ListInvalidationsResult listInvalidations(ListInvalidationsRequest request)
AmazonCloudFront
Lists invalidation batches.
listInvalidations
in interface AmazonCloudFront
request
- The request to list invalidations.public ListKeyGroupsResult listKeyGroups(ListKeyGroupsRequest request)
AmazonCloudFront
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.
listKeyGroups
in interface AmazonCloudFront
public ListKeyValueStoresResult listKeyValueStores(ListKeyValueStoresRequest request)
AmazonCloudFront
Specifies the key value stores to list.
listKeyValueStores
in interface AmazonCloudFront
public ListOriginAccessControlsResult listOriginAccessControls(ListOriginAccessControlsRequest request)
AmazonCloudFront
Gets the list of CloudFront origin access controls in this Amazon Web Services 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 another request that specifies the NextMarker
value from the current
response as the Marker
value in the next request.
listOriginAccessControls
in interface AmazonCloudFront
public ListOriginRequestPoliciesResult listOriginRequestPolicies(ListOriginRequestPoliciesRequest request)
AmazonCloudFront
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listOriginRequestPolicies
in interface AmazonCloudFront
public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
AmazonCloudFront
List all public keys that have been added to CloudFront for this account.
listPublicKeys
in interface AmazonCloudFront
public ListRealtimeLogConfigsResult listRealtimeLogConfigs(ListRealtimeLogConfigsRequest request)
AmazonCloudFront
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.
listRealtimeLogConfigs
in interface AmazonCloudFront
public ListResponseHeadersPoliciesResult listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest request)
AmazonCloudFront
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listResponseHeadersPolicies
in interface AmazonCloudFront
public ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest request)
AmazonCloudFront
List streaming distributions.
listStreamingDistributions
in interface AmazonCloudFront
request
- The request to list your streaming distributions.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonCloudFront
List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
listTagsForResource
in interface AmazonCloudFront
request
- The request to list tags for a CloudFront resource.public PublishFunctionResult publishFunction(PublishFunctionRequest request)
AmazonCloudFront
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
.
publishFunction
in interface AmazonCloudFront
public TagResourceResult tagResource(TagResourceRequest request)
AmazonCloudFront
Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
tagResource
in interface AmazonCloudFront
request
- The request to add tags to a CloudFront resource.public TestFunctionResult testFunction(TestFunctionRequest request)
AmazonCloudFront
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
.
testFunction
in interface AmazonCloudFront
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonCloudFront
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
untagResource
in interface AmazonCloudFront
request
- The request to remove tags from a CloudFront resource.public UpdateCachePolicyResult updateCachePolicy(UpdateCachePolicyRequest request)
AmazonCloudFront
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.
updateCachePolicy
in interface AmazonCloudFront
public UpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest request)
AmazonCloudFront
Update an origin access identity.
updateCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
request
- The request to update an origin access identity.public UpdateContinuousDeploymentPolicyResult updateContinuousDeploymentPolicy(UpdateContinuousDeploymentPolicyRequest request)
AmazonCloudFront
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
Use GetContinuousDeploymentPolicyConfig
to get the current configuration.
Locally modify the fields in the continuous deployment policy configuration that you want to update.
Use UpdateContinuousDeploymentPolicy
, providing the entire continuous deployment policy
configuration, including the fields that you modified and those that you didn't.
updateContinuousDeploymentPolicy
in interface AmazonCloudFront
public UpdateDistributionResult updateDistribution(UpdateDistributionRequest request)
AmazonCloudFront
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and
then submitting an UpdateDistribution
request to make the updates.
To update a web distribution using the CloudFront API
Use GetDistributionConfig
to get the current configuration, including the version identifier (
ETag
).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must rename the ETag
field to IfMatch
, leaving the value unchanged. (Set the value
of IfMatch
to the value of ETag
, then remove the ETag
field.)
You can't change the value of CallerReference
.
Submit an UpdateDistribution
request, providing the distribution configuration. The new
configuration replaces the existing configuration. The values that you specify in an
UpdateDistribution
request are not merged into your existing configuration. Make sure to include all
fields: the ones that you modified and also the ones that you didn't.
updateDistribution
in interface AmazonCloudFront
request
- The request to update a distribution.public UpdateDistributionWithStagingConfigResult updateDistributionWithStagingConfig(UpdateDistributionWithStagingConfigRequest request)
AmazonCloudFront
Copies the staging distribution's configuration to its corresponding primary distribution. The primary
distribution retains its Aliases
(also known as alternate domain names or CNAMEs) and
ContinuousDeploymentPolicyId
value, but otherwise its configuration is overwritten to match the
staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
updateDistributionWithStagingConfig
in interface AmazonCloudFront
public UpdateFieldLevelEncryptionConfigResult updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest request)
AmazonCloudFront
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfig
in interface AmazonCloudFront
public UpdateFieldLevelEncryptionProfileResult updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest request)
AmazonCloudFront
Update a field-level encryption profile.
updateFieldLevelEncryptionProfile
in interface AmazonCloudFront
public UpdateFunctionResult updateFunction(UpdateFunctionRequest request)
AmazonCloudFront
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
.
updateFunction
in interface AmazonCloudFront
public UpdateKeyGroupResult updateKeyGroup(UpdateKeyGroupRequest request)
AmazonCloudFront
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.
updateKeyGroup
in interface AmazonCloudFront
public UpdateKeyValueStoreResult updateKeyValueStore(UpdateKeyValueStoreRequest request)
AmazonCloudFront
Specifies the key value store to update.
updateKeyValueStore
in interface AmazonCloudFront
public UpdateOriginAccessControlResult updateOriginAccessControl(UpdateOriginAccessControlRequest request)
AmazonCloudFront
Updates a CloudFront origin access control.
updateOriginAccessControl
in interface AmazonCloudFront
public UpdateOriginRequestPolicyResult updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest request)
AmazonCloudFront
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.
updateOriginRequestPolicy
in interface AmazonCloudFront
public UpdatePublicKeyResult updatePublicKey(UpdatePublicKeyRequest request)
AmazonCloudFront
Update public key information. Note that the only value you can change is the comment.
updatePublicKey
in interface AmazonCloudFront
public UpdateRealtimeLogConfigResult updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest request)
AmazonCloudFront
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
.
updateRealtimeLogConfig
in interface AmazonCloudFront
public UpdateResponseHeadersPolicyResult updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest request)
AmazonCloudFront
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use GetResponseHeadersPolicyConfig
to get the current policy's configuration.
Modify the fields in the response headers policy configuration that you want to update.
Call UpdateResponseHeadersPolicy
, providing the entire response headers policy configuration,
including the fields that you modified and those that you didn't.
updateResponseHeadersPolicy
in interface AmazonCloudFront
public UpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest request)
AmazonCloudFront
Update a streaming distribution.
updateStreamingDistribution
in interface AmazonCloudFront
request
- The request to update a streaming distribution.public void shutdown()
AmazonCloudFront
shutdown
in interface AmazonCloudFront
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudFront
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonCloudFront
request
- The originally executed request.public AmazonCloudFrontWaiters waiters()
waiters
in interface AmazonCloudFront