@aws-sdk/client-rds

v3.697.0

AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native For more information about how to use this package see README

Latest version published 1 day ago

License: Apache-2.0

NPM

GitHub

Package Health Score

98 / 100

security
No known security issues
popularity
Influential project
maintenance
Healthy
community
Active

Explore Similar Packages

aws-sdk
90

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.697.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.696.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.687.0	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.645.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.637.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (389,802)

GitHub Stars: 3.12K
Forks: 578
Contributors: 150

Direct Usage Popularity

The npm package @aws-sdk/client-rds receives a total of 389,802 downloads a week. As such, we scored @aws-sdk/client-rds popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @aws-sdk/client-rds, we found that it has been starred 3,121 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for @aws-sdk/client-rds project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 185
Open PR: 19
Last Release: 1 day ago
Last Commit: 6 days ago

Further analysis of the maintenance status of @aws-sdk/client-rds based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @aws-sdk/client-rds demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.0.0

Age: 5 years
Dependencies: 43 Direct
Versions: 464
Install Size: 5.47 MB
Dist-tags: 5
# of Files: 713
Maintainers: 5
TS Typings: Yes

@aws-sdk/client-rds has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@aws-sdk/client-rds

Description

AWS SDK for JavaScript RDS Client for Node.js, Browser and React Native.

Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.

Amazon RDS User Guide

For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.

Installing

To install this package, simply type add or install @aws-sdk/client-rds using your favorite package manager:

npm install @aws-sdk/client-rds
yarn add @aws-sdk/client-rds
pnpm add @aws-sdk/client-rds

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the RDSClient and the commands you need, for example ListTagsForResourceCommand:

// ES5 example
const { RDSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-rds");

// ES6+ example
import { RDSClient, ListTagsForResourceCommand } from "@aws-sdk/client-rds";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region).
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new RDSClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListTagsForResourceCommand(params);

Async/await

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.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) =&gt; {
    // process data.
  },
  (error) =&gt; {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  })
  .finally(() =&gt; {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) =&gt; {
  // process err and data.
});

v2 compatible style

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-rds";
const client = new AWS.RDS({ region: "REGION" });

// async/await.
try {
  const data = await client.listTagsForResource(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTagsForResource(params)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  });

// callbacks.
client.listTagsForResource(params, (err, data) =&gt; {
  // process err and data.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

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.

Visit Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-rds package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AddRoleToDBCluster

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (389,802)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@aws-sdk/client-rds

Description

Installing

Getting Started

Import

Usage

Async/await

Promises

Callbacks

v2 compatible style

Troubleshooting

Getting Help

Contributing

License

Client Commands (Operations List)

@aws-sdk/client-rds dependencies

@aws-sdk/client-rds development dependencies

FAQs

What is @aws-sdk/client-rds?

Is @aws-sdk/client-rds popular?

Is @aws-sdk/client-rds well maintained?

Is @aws-sdk/client-rds safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues