Class: AWS.CloudFront
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.CloudFront
- Identifier:
- cloudfront
- API Version:
- 2020-05-31
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
Sending a Request Using CloudFront
var cloudfront = new AWS.CloudFront();
cloudfront.associateAlias(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the CloudFront object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var cloudfront = new AWS.CloudFront({apiVersion: '2020-05-31'});
You can also set the API version globally in AWS.config.apiVersions using
the cloudfront service identifier:
AWS.config.apiVersions = {
cloudfront: '2020-05-31',
// other service API versions
};
var cloudfront = new AWS.CloudFront();
Defined Under Namespace
Classes: Signer
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
distributionDeployed, invalidationCompleted, streamingDistributionDeployed
Constructor Summary collapse
-
new AWS.CloudFront(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateAlias(params = {}, callback) ⇒ AWS.Request
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.
-
copyDistribution(params = {}, callback) ⇒ AWS.Request
Creates a staging distribution using the configuration of the provided primary distribution.
-
createCachePolicy(params = {}, callback) ⇒ AWS.Request
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors.
-
createCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request
Creates a new origin access identity.
-
createContinuousDeploymentPolicy(params = {}, callback) ⇒ AWS.Request
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
CopyDistributionto create a staging distribution, then useUpdateDistributionto 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.
-
createDistribution(params = {}, callback) ⇒ AWS.Request
Creates a CloudFront distribution.
.
-
createDistributionWithTags(params = {}, callback) ⇒ AWS.Request
Create a new distribution with tags.
-
createFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request
Create a new field-level encryption configuration.
.
-
createFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request
Create a field-level encryption profile.
.
-
createFunction(params = {}, callback) ⇒ AWS.Request
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function.
-
createInvalidation(params = {}, callback) ⇒ AWS.Request
Create a new invalidation.
-
createKeyGroup(params = {}, callback) ⇒ AWS.Request
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.
-
createKeyValueStore(params = {}, callback) ⇒ AWS.Request
Specifies the key value store resource to add to your account.
-
createMonitoringSubscription(params = {}, callback) ⇒ AWS.Request
Enables additional CloudWatch metrics for the specified CloudFront distribution.
-
createOriginAccessControl(params = {}, callback) ⇒ AWS.Request
Creates a new origin access control in CloudFront.
-
createOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors.
-
createPublicKey(params = {}, callback) ⇒ AWS.Request
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
.
-
createRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request
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.
. -
createResponseHeadersPolicy(params = {}, callback) ⇒ AWS.Request
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers.
-
createStreamingDistribution(params = {}, callback) ⇒ AWS.Request
This API is deprecated.
-
createStreamingDistributionWithTags(params = {}, callback) ⇒ AWS.Request
This API is deprecated.
-
deleteCachePolicy(params = {}, callback) ⇒ AWS.Request
Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior.
-
deleteCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request
Delete an origin access identity.
.
-
deleteContinuousDeploymentPolicy(params = {}, callback) ⇒ AWS.Request
Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution.
-
deleteDistribution(params = {}, callback) ⇒ AWS.Request
Delete a distribution.
.
-
deleteFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request
Remove a field-level encryption configuration.
.
-
deleteFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request
Remove a field-level encryption profile.
.
-
deleteFunction(params = {}, callback) ⇒ AWS.Request
Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior.
-
deleteKeyGroup(params = {}, callback) ⇒ AWS.Request
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior.
-
deleteKeyValueStore(params = {}, callback) ⇒ AWS.Request
Specifies the key value store to delete.
.
-
deleteMonitoringSubscription(params = {}, callback) ⇒ AWS.Request
Disables additional CloudWatch metrics for the specified CloudFront distribution.
.
-
deleteOriginAccessControl(params = {}, callback) ⇒ AWS.Request
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use.
-
deleteOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request
Deletes an origin request policy.
You cannot delete an origin request policy if it's attached to any cache behaviors.
-
deletePublicKey(params = {}, callback) ⇒ AWS.Request
Remove a public key you previously added to CloudFront.
.
-
deleteRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior.
-
deleteResponseHeadersPolicy(params = {}, callback) ⇒ AWS.Request
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior.
-
deleteStreamingDistribution(params = {}, callback) ⇒ AWS.Request
Delete a streaming distribution.
-
describeFunction(params = {}, callback) ⇒ AWS.Request
Gets configuration information and metadata about a CloudFront function, but not the function's code.
-
describeKeyValueStore(params = {}, callback) ⇒ AWS.Request
Specifies the key value store and its configuration.
.
-
getCachePolicy(params = {}, callback) ⇒ AWS.Request
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.
-
-
getCachePolicyConfig(params = {}, callback) ⇒ AWS.Request
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's identifier.
-
getCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request
Get the information about an origin access identity.
.
-
getCloudFrontOriginAccessIdentityConfig(params = {}, callback) ⇒ AWS.Request
Get the configuration information about an origin access identity.
.
-
getContinuousDeploymentPolicy(params = {}, callback) ⇒ AWS.Request
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
.
-
getContinuousDeploymentPolicyConfig(params = {}, callback) ⇒ AWS.Request
Gets configuration information about a continuous deployment policy.
.
-
getDistribution(params = {}, callback) ⇒ AWS.Request
Get the information about a distribution.
.
-
getDistributionConfig(params = {}, callback) ⇒ AWS.Request
Get the configuration information about a distribution.
.
-
getFieldLevelEncryption(params = {}, callback) ⇒ AWS.Request
Get the field-level encryption configuration information.
.
-
getFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request
Get the field-level encryption configuration information.
.
-
getFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request
Get the field-level encryption profile information.
.
-
getFieldLevelEncryptionProfileConfig(params = {}, callback) ⇒ AWS.Request
Get the field-level encryption profile configuration information.
.
-
getFunction(params = {}, callback) ⇒ AWS.Request
Gets the code of a CloudFront function.
-
getInvalidation(params = {}, callback) ⇒ AWS.Request
Get the information about an invalidation.
.
-
getKeyGroup(params = {}, callback) ⇒ AWS.Request
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.
-
getKeyGroupConfig(params = {}, callback) ⇒ AWS.Request
Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier.
-
getMonitoringSubscription(params = {}, callback) ⇒ AWS.Request
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
.
-
getOriginAccessControl(params = {}, callback) ⇒ AWS.Request
Gets a CloudFront origin access control, including its unique identifier.
.
-
getOriginAccessControlConfig(params = {}, callback) ⇒ AWS.Request
Gets a CloudFront origin access control configuration.
.
-
getOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request
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.
-
-
getOriginRequestPolicyConfig(params = {}, callback) ⇒ AWS.Request
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy's identifier.
-
getPublicKey(params = {}, callback) ⇒ AWS.Request
Gets a public key.
.
-
getPublicKeyConfig(params = {}, callback) ⇒ AWS.Request
Gets a public key configuration.
.
-
getRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request
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).
-
getResponseHeadersPolicy(params = {}, callback) ⇒ AWS.Request
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.
-
getResponseHeadersPolicyConfig(params = {}, callback) ⇒ AWS.Request
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier.
-
getStreamingDistribution(params = {}, callback) ⇒ AWS.Request
Gets information about a specified RTMP distribution, including the distribution configuration.
.
-
getStreamingDistributionConfig(params = {}, callback) ⇒ AWS.Request
Get the configuration information about a streaming distribution.
.
-
listCachePolicies(params = {}, callback) ⇒ AWS.Request
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.
-
listCloudFrontOriginAccessIdentities(params = {}, callback) ⇒ AWS.Request
Lists origin access identities.
.
-
listConflictingAliases(params = {}, callback) ⇒ AWS.Request
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.
-
listContinuousDeploymentPolicies(params = {}, callback) ⇒ AWS.Request
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.
-
listDistributions(params = {}, callback) ⇒ AWS.Request
List CloudFront distributions.
.
-
listDistributionsByCachePolicyId(params = {}, callback) ⇒ AWS.Request
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.
-
listDistributionsByKeyGroup(params = {}, callback) ⇒ AWS.Request
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.
-
listDistributionsByOriginRequestPolicyId(params = {}, callback) ⇒ AWS.Request
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.
-
listDistributionsByRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request
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).
-
listDistributionsByResponseHeadersPolicyId(params = {}, callback) ⇒ AWS.Request
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.
-
listDistributionsByWebACLId(params = {}, callback) ⇒ AWS.Request
List the distributions that are associated with a specified WAF web ACL.
.
-
listFieldLevelEncryptionConfigs(params = {}, callback) ⇒ AWS.Request
List all field-level encryption configurations that have been created in CloudFront for this account.
.
-
listFieldLevelEncryptionProfiles(params = {}, callback) ⇒ AWS.Request
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
.
-
listFunctions(params = {}, callback) ⇒ AWS.Request
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
DEVELOPMENTorLIVE.You can optionally specify the maximum number of items to receive in the response.
-
listInvalidations(params = {}, callback) ⇒ AWS.Request
Lists invalidation batches.
.
-
listKeyGroups(params = {}, callback) ⇒ AWS.Request
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response.
-
listKeyValueStores(params = {}, callback) ⇒ AWS.Request
Specifies the key value stores to list.
.
-
listOriginAccessControls(params = {}, callback) ⇒ AWS.Request
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.
-
listOriginRequestPolicies(params = {}, callback) ⇒ AWS.Request
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.