@aws-sdk/rds-signer 3.421.0 → 3.422.1

package/dist-types/ts3.4/Signer.d.ts

@@ -1,26 +1,42 @@
-import {
-  AwsCredentialIdentity,
-  AwsCredentialIdentityProvider,
-  ChecksumConstructor,
-  HashConstructor,
-} from "@smithy/types";
-export interface SignerConfig {
-  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
-  hostname: string;
-  port: number;
-  region?: string;
-  sha256?: ChecksumConstructor | HashConstructor;
-  username: string;
-}
-export declare class Signer {
-  private readonly credentials;
-  private readonly hostname;
-  private readonly port;
-  private readonly protocol;
-  private readonly region;
-  private readonly service;
-  private readonly sha256;
-  private readonly username;
-  constructor(configuration: SignerConfig);
-  getAuthToken(): Promise<string>;
-}
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider, ChecksumConstructor, HashConstructor } from "@smithy/types";
+export interface SignerConfig {
+    /**
+     * The AWS credentials to sign requests with. Uses the default credential provider chain if not specified.
+     */
+    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+    /**
+     * The hostname of the database to connect to.
+     */
+    hostname: string;
+    /**
+     * The port number the database is listening on.
+     */
+    port: number;
+    /**
+     * The region the database is located in. Uses the region inferred from the runtime if omitted.
+     */
+    region?: string;
+    /**
+     * The SHA256 hasher constructor to sign the request.
+     */
+    sha256?: ChecksumConstructor | HashConstructor;
+    /**
+     * The username to login as.
+     */
+    username: string;
+}
+/**
+ * The signer class that generates an auth token to a database.
+ */
+export declare class Signer {
+    private readonly credentials;
+    private readonly hostname;
+    private readonly port;
+    private readonly protocol;
+    private readonly region;
+    private readonly service;
+    private readonly sha256;
+    private readonly username;
+    constructor(configuration: SignerConfig);
+    getAuthToken(): Promise<string>;
+}

package/dist-types/ts3.4/index.d.ts

@@ -1 +1 @@
-export * from "./Signer";
+export * from "./Signer";

package/dist-types/ts3.4/runtimeConfig.browser.d.ts

@@ -1,13 +1,13 @@
-import { SignerConfig } from "./Signer";
-export declare const getRuntimeConfig: (config: SignerConfig) => {
-  credentials:
-    | import("@smithy/types").AwsCredentialIdentity
-    | import("@smithy/types").AwsCredentialIdentityProvider
-    | import("@smithy/types").Provider<any>;
-  hostname: string;
-  port: number;
-  region: string | import("@smithy/types").Provider<any>;
-  sha256: import("@smithy/types").HashConstructor;
-  username: string;
-  runtime: string;
-};
+import { SignerConfig } from "./Signer";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: SignerConfig) => {
+    credentials: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | import("@smithy/types").Provider<any>;
+    hostname: string;
+    port: number;
+    region: string | import("@smithy/types").Provider<any>;
+    sha256: import("@smithy/types").HashConstructor;
+    username: string;
+    runtime: string;
+};

package/dist-types/ts3.4/runtimeConfig.d.ts

@@ -1,12 +1,13 @@
-import { SignerConfig } from "./Signer";
-export declare const getRuntimeConfig: (config: SignerConfig) => {
-  credentials:
-    | import("@smithy/types").AwsCredentialIdentity
-    | import("@smithy/types").AwsCredentialIdentityProvider;
-  hostname: string;
-  port: number;
-  region: string | import("@smithy/types").Provider<string>;
-  sha256: import("@smithy/types").HashConstructor;
-  username: string;
-  runtime: string;
-};
+import { SignerConfig } from "./Signer";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: SignerConfig) => {
+    credentials: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider;
+    hostname: string;
+    port: number;
+    region: string | import("@smithy/types").Provider<string>;
+    sha256: import("@smithy/types").HashConstructor;
+    username: string;
+    runtime: string;
+};

package/dist-types/ts3.4/runtimeConfig.native.d.ts

@@ -1,13 +1,13 @@
-import { SignerConfig } from "./Signer";
-export declare const getRuntimeConfig: (config: SignerConfig) => {
-  credentials:
-    | import("@smithy/types").AwsCredentialIdentity
-    | import("@smithy/types").AwsCredentialIdentityProvider
-    | import("@smithy/types").Provider<any>;
-  hostname: string;
-  port: number;
-  region: string | import("@smithy/types").Provider<any>;
-  sha256: import("@smithy/types").HashConstructor;
-  username: string;
-  runtime: string;
-};
+import { SignerConfig } from "./Signer";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: SignerConfig) => {
+    credentials: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | import("@smithy/types").Provider<any>;
+    hostname: string;
+    port: number;
+    region: string | import("@smithy/types").Provider<any>;
+    sha256: import("@smithy/types").HashConstructor;
+    username: string;
+    runtime: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/rds-signer",
-  "version": "3.421.0",
+  "version": "3.422.1",
   "description": "RDS utility for generating a password that can be used for IAM authentication to an RDS DB.",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -27,7 +27,7 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/credential-providers": "3.421.0",
+    "@aws-sdk/credential-providers": "3.422.0",
     "@aws-sdk/util-format-url": "3.418.0",
     "@smithy/config-resolver": "^2.0.10",
     "@smithy/hash-node": "^2.0.9",