Node AWS-ACM

A lightweight npm package to interact with AWS Certificate Manager (ACM) using Node.js.

Table of Contents

• Description
• Installation
• Usage
• Examples
• Changelog
• License

Description

node-aws-acm is a user-friendly and easy-to-use package for managing SSL/TLS certificates on AWS using the AWS Certificate Manager (ACM). The package provides a simple interface for connecting to ACM, allowing developers to perform various ACM-related tasks such as listing certificates, requesting new certificates, and managing domain validation.

Use cases

• Automating certificate management tasks in your Node.js applications.
• Building custom tools or services to manage your SSL/TLS certificates on AWS.
• Integrating SSL/TLS certificate management into your existing Node.js projects.

Prerequisites

You must have the following installed:

• Node.js (version 16 or higher recommended)
• AWS SDK for JavaScript
• AWS credentials with permissions to use ACM

Installation

Install node-aws-acm using npm:

npm install node-aws-acm

Usage

1. Set up your AWS credentials and region: You can set your AWS credentials and region using environment variables:

export AWS_ACCESS_KEY_ID=your_access_key_id
export AWS_SECRET_ACCESS_KEY=your_secret_access_key
export AWS_REGION=your_region

Alternatively, create a .env file with the following contents:

AWS_ACCESS_KEY_ID=your_access_key_id
AWS_SECRET_ACCESS_KEY=your_secret_access_key
AWS_REGION=your_region

Replace your_access_key_id, your_secret_access_key, and your_region with your actual AWS credentials and the desired region.

2. Create a script that uses node-aws-acm to interact with ACM:

const ACMAutoConnect = require("node-aws-acm");

const acm = new ACMAutoConnect();

(async () => {
  const certificates = await acm.listCertificates();
  console.log(certificates);
})();

This script loads AWS credentials and region from the .env file and lists all SSL/TLS certificates available in your ACM.

Alernatively use examples dir to test and check ssl certificates inside AWS ACM Note: you need to create .env file copy from .env.example file.

Examples

Examples can be found in the examples folder. The following operations are available:

• Create a new certificate: CreateCertificate.js
• Delete a domain certificate: DeleteDomainCertificate.js
• Get a specific domain certificate: getSpecificDomainCertificate.js
• List all certificates: listAllCertificates.js

Documentation

For detailed documentation, refer to the source code and comments in the node-aws-acm package.

Additionally, consult the following external resources for more information about AWS SDK and ACM:

• AWS SDK for JavaScript in Node.js Documentation: Official documentation for the AWS SDK for JavaScript, including usage examples, best practices, and API reference.
• AWS Certificate Manager (ACM) Documentation: Official documentation for AWS Certificate Manager, covering topics such as requesting and managing SSL/TLS certificates, certificate renewal, and domain validation. These resources will provide you with in-depth information about using the AWS SDK for JavaScript and working with the AWS Certificate Manager.

Changelog

Refer to the CHANGELOG.md file for the list of changes and updates.

License

This project is licensed under the ISC License.