@aws-sdk/client-cloudfront
Advanced tools
AWS SDK for JavaScript Cloudfront Client for Node.js, Browser and React Native
@aws-sdk/client-cloudfront is a part of the AWS SDK for JavaScript, which allows developers to interact with Amazon CloudFront, a content delivery network (CDN) service. This package provides a variety of functionalities to manage CloudFront distributions, invalidations, and other related resources.
Create CloudFront Distribution
This feature allows you to create a new CloudFront distribution. The code sample demonstrates how to set up a distribution with a custom origin and default cache behavior.
const { CloudFrontClient, CreateDistributionCommand } = require('@aws-sdk/client-cloudfront');
const client = new CloudFrontClient({ region: 'us-east-1' });
const params = {
DistributionConfig: {
CallerReference: 'unique-string',
Origins: {
Quantity: 1,
Items: [
{
Id: 'origin-1',
DomainName: 'example.com',
CustomOriginConfig: {
HTTPPort: 80,
HTTPSPort: 443,
OriginProtocolPolicy: 'http-only'
}
}
]
},
DefaultCacheBehavior: {
TargetOriginId: 'origin-1',
ViewerProtocolPolicy: 'allow-all',
ForwardedValues: {
QueryString: false,
Cookies: {
Forward: 'none'
}
},
TrustedSigners: {
Enabled: false,
Quantity: 0
}
},
Enabled: true
}
};
const run = async () => {
try {
const data = await client.send(new CreateDistributionCommand(params));
console.log('Distribution created:', data);
} catch (err) {
console.error('Error creating distribution:', err);
}
};
run();List CloudFront Distributions
This feature allows you to list all CloudFront distributions in your AWS account. The code sample demonstrates how to retrieve and log the list of distributions.
const { CloudFrontClient, ListDistributionsCommand } = require('@aws-sdk/client-cloudfront');
const client = new CloudFrontClient({ region: 'us-east-1' });
const run = async () => {
try {
const data = await client.send(new ListDistributionsCommand({}));
console.log('Distributions:', data.DistributionList.Items);
} catch (err) {
console.error('Error listing distributions:', err);
}
};
run();Create Invalidation
This feature allows you to create an invalidation for a CloudFront distribution. The code sample demonstrates how to invalidate specific paths in a distribution.
const { CloudFrontClient, CreateInvalidationCommand } = require('@aws-sdk/client-cloudfront');
const client = new CloudFrontClient({ region: 'us-east-1' });
const params = {
DistributionId: 'EXAMPLE_DIST_ID',
InvalidationBatch: {
CallerReference: 'unique-string',
Paths: {
Quantity: 1,
Items: ['/path/to/invalidate']
}
}
};
const run = async () => {
try {
const data = await client.send(new CreateInvalidationCommand(params));
console.log('Invalidation created:', data);
} catch (err) {
console.error('Error creating invalidation:', err);
}
};
run();The 'cloudflare' npm package allows developers to interact with Cloudflare's CDN and other services. It provides functionalities similar to @aws-sdk/client-cloudfront, such as managing DNS records, creating and managing zones, and purging cache. However, it is specific to Cloudflare's infrastructure.
The 'fastly' npm package provides an interface to interact with Fastly's CDN services. It offers functionalities like creating and managing services, purging cache, and configuring domains. This package is specific to Fastly's CDN platform and offers similar capabilities to @aws-sdk/client-cloudfront but within the Fastly ecosystem.
The 'akamai-edgegrid' npm package allows developers to interact with Akamai's CDN and other services. It provides functionalities for managing edge configurations, purging cache, and monitoring traffic. This package is tailored for Akamai's platform and offers similar CDN management capabilities as @aws-sdk/client-cloudfront.
AWS SDK for JavaScript CloudFront Client for Node.js, Browser and React Native.
Amazon CloudFront
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.
To install the this package, simply type add or install @aws-sdk/client-cloudfront using your favorite package manager:
npm install @aws-sdk/client-cloudfrontyarn add @aws-sdk/client-cloudfrontpnpm add @aws-sdk/client-cloudfrontThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CloudFrontClient and
the commands you need, for example ListCachePoliciesCommand:
// ES5 example
const { CloudFrontClient, ListCachePoliciesCommand } = require("@aws-sdk/client-cloudfront");
// ES6+ example
import { CloudFrontClient, ListCachePoliciesCommand } from "@aws-sdk/client-cloudfront";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new CloudFrontClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListCachePoliciesCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-cloudfront";
const client = new AWS.CloudFront({ region: "REGION" });
// async/await.
try {
const data = await client.listCachePolicies(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listCachePolicies(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listCachePolicies(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-cloudfront package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.637.0 (2024-08-22)
FAQs
AWS SDK for JavaScript Cloudfront Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-cloudfront receives a total of 188,723 weekly downloads. As such, @aws-sdk/client-cloudfront popularity was classified as popular.
We found that @aws-sdk/client-cloudfront demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.