Back to Aws Sdk Js V3

@aws-sdk/rds-signer

packages/rds-signer/README.md

3.1043.02.5 KB
Original Source

@aws-sdk/rds-signer

Description

This package provides utilities for interacting with RDS.

Installation

console
npm install @aws-sdk/rds-signer

Getting Started

Import

ES6 import

js
import { Signer } from "@aws-sdk/rds-signer";

Or CommonJS import

js
const { Signer } = require("@aws-sdk/rds-signer");

Generate Authentication Token for RDS IAM Authentication

js
const signer = new Signer({
  /**
   * Required. The hostname of the database to connect to.
   */
  hostname: "db.us-east-1.rds.amazonaws.com",
  /**
   * Required. The port number the database is listening on.
   */
  port: 8000,
  /**
   * Required. The username to login as.
   */
  username: "user1",
  /**
   * Optional. The AWS credentials to sign requests with. Uses the default credential provider chain if not specified.
   */
  credentials: fromNodeCredentialProvider(),
  /**
   * Optional. The region the database is located in. Uses the region inferred from the runtime if omitted.
   */
  region: "us-east-1",
  /**
   * Optional. The SHA256 hasher constructor to sign the request.
   */
  sha256: HashCtor,
});

const token = await signer.getAuthToken();
// Use this token as the password for connecting to your RDS instance

For more details and examples, refer to the following resources. Usage is similar across DB engines.