Skip to content

Commit e4ff49a

Browse files
committed
chore(nested-clients): mark as internal
1 parent 33e3afd commit e4ff49a

File tree

4 files changed

+14
-74
lines changed

4 files changed

+14
-74
lines changed

packages/nested-clients/README.md

Lines changed: 2 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,5 @@
1-
# @aws-sdk/rds-signer
2-
3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/rds-signer/latest.svg)](https://www.npmjs.com/package/@aws-sdk/rds-signer)
4-
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/rds-signer.svg)](https://www.npmjs.com/package/@aws-sdk/rds-signer)
1+
# @aws-sdk/nested-clients
52

63
## Description
74

8-
This package provides utilities for interacting with RDS.
9-
10-
## Installation
11-
12-
```console
13-
npm install @aws-sdk/rds-signer
14-
```
15-
16-
## Getting Started
17-
18-
### Import
19-
20-
ES6 import
21-
22-
```js
23-
import { Signer } from "@aws-sdk/rds-signer";
24-
```
25-
26-
Or CommonJS import
27-
28-
```js
29-
const { Signer } = require("@aws-sdk/rds-signer");
30-
```
31-
32-
### Generate Authentication Token for RDS IAM Authentication
33-
34-
```js
35-
const signer = new Signer({
36-
/**
37-
* Required. The hostname of the database to connect to.
38-
*/
39-
hostname: "db.us-east-1.rds.amazonaws.com",
40-
/**
41-
* Required. The port number the database is listening on.
42-
*/
43-
port: 8000,
44-
/**
45-
* Required. The username to login as.
46-
*/
47-
username: "user1",
48-
/**
49-
* Optional. The AWS credentials to sign requests with. Uses the default credential provider chain in not specified.
50-
*/
51-
credentials: fromNodeCredentialProvider(),
52-
/**
53-
* Optional. The region the database is located in. Uses the region inferred from the runtime if omitted.
54-
*/
55-
region: "us-east-1",
56-
/**
57-
* Optional. The SHA256 hasher constructor to sign the request.
58-
*/
59-
sha256: HashCtor,
60-
});
61-
62-
const token = await signer.getAuthToken();
63-
// Use this token as the password for connecting to your RDS instance
64-
```
65-
66-
For more details and examples, refer to the following resources. Usage is similar across DB engines.
67-
68-
- [Connecting to your DB instance using IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html)
69-
- [IAM database authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
70-
- [Using IAM authentication to connect with pgAdmin Amazon Aurora PostgreSQL or Amazon RDS for PostgreSQL](https://aws.amazon.com/blogs/database/using-iam-authentication-to-connect-with-pgadmin-amazon-aurora-postgresql-or-amazon-rds-for-postgresql/)
71-
- [Use IAM authentication to connect with SQL Workbench/J to Amazon Aurora MySQL or Amazon RDS for MySQL](https://aws.amazon.com/blogs/database/use-iam-authentication-to-connect-with-sql-workbenchj-to-amazon-aurora-mysql-or-amazon-rds-for-mysql/)
72-
- [AWS CLI v2 rds generate-db-auth-token Documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-db-auth-token.html)
5+
This is an internal package. Do not install this as a direct dependency.

packages/nested-clients/api-extractor.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

packages/nested-clients/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
"build:types": "tsc -p tsconfig.types.json",
1414
"build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
1515
"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
16-
"extract:docs": "api-extractor run --local",
1716
"test": "yarn g:vitest run",
1817
"test:watch": "yarn g:vitest watch"
1918
},

packages/nested-clients/src/index.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1+
/**
2+
* @internal
3+
*/
14
export { CreateTokenCommand, SSOOIDCClient } from "./nested-sso-oidc/index";
25

6+
/**
7+
* @internal
8+
*/
39
export type { SSOOIDCClientConfig, CreateTokenCommandInput } from "./nested-sso-oidc";
410

11+
/**
12+
* @internal
13+
*/
514
export {
615
AssumeRoleCommand,
716
AssumeRoleWithWebIdentityCommand,
@@ -10,4 +19,7 @@ export {
1019
getDefaultRoleAssumerWithWebIdentity,
1120
} from "./nested-sts/index";
1221

22+
/**
23+
* @internal
24+
*/
1325
export type { AssumeRoleCommandInput, STSClientConfig } from "./nested-sts";

0 commit comments

Comments
 (0)