This package has been deprecated

Author message:

The package @aws-sdk/client-rds-browser has been renamed to @aws-sdk/client-rds. Please install the renamed package.

@aws-sdk/client-rds-browser

Description

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, resizable 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, 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. Note that 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 the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-rds-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(RDSClient) and the commands you need, for example AddRoleToDBClusterCommand:

//JavaScript
const { RDSClient } = require("@aws-sdk/client-rds-browser/RDSClient");
const {
  AddRoleToDBClusterCommand
} = require("@aws-sdk/client-rds-browser/commands/AddRoleToDBClusterCommand");

//TypeScript
import { RDSClient } from "@aws-sdk/client-rds-browser/RDSClient";
import { AddRoleToDBClusterCommand } from "@aws-sdk/client-rds-browser/commands/AddRoleToDBClusterCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const rDS = new RDSClient({region: 'region'});
//clients can be shared by different commands
const params = {
  DBClusterIdentifier: /**a string value*/,
  RoleArn: /**a string value*/,
};
const addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);
rDS.send(addRoleToDBClusterCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await rDS.send(addRoleToDBClusterCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
rDS.send(addRoleToDBClusterCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-rds-browser/RDS";
const rDS = new AWS.RDS({ region: "region" });
rDS.addRoleToDBCluster(params, (err, data) => {
  //do something
});

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 rDS.send(addRoleToDBClusterCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-rds-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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