wrapped-client-secrets-manager

This package wraps the Secrets Manager Client - AWS SDK for JavaScript v3 to provide consistent logging and other services.

API Documentation

wrapped-secrets-manager-client

• wrapped-secrets-manager-client
  • static
    • .WrappedSecretsManagerClient
      • new exports.WrappedSecretsManagerClient([options])
      • .createSecret(options) ⇒ Promise.<CreateSecretResponse>
      • .deleteSecret(options) ⇒ Promise.<DeleteSecretResponse>
      • .describeSecret(options) ⇒ Promise.<object>
      • .getSecretValue(options) ⇒ Promise.<GetSecretValueResponse>
      • .putSecretValue(options) ⇒ Promise.<PutSecretValueResponse>
  • inner
    • ~CreateSecretResponse : object
    • ~DeleteSecretResponse : object
    • ~GetSecretValueResponse : object
    • ~PutSecretValueResponse : object

wrapped-secrets-manager-client.WrappedSecretsManagerClient

Wraps an AWS Secrets Manager client to provide standard logging & services.

Kind: static class of wrapped-secrets-manager-client

• .WrappedSecretsManagerClient
  • new exports.WrappedSecretsManagerClient([options])
  • .createSecret(options) ⇒ Promise.<CreateSecretResponse>
  • .deleteSecret(options) ⇒ Promise.<DeleteSecretResponse>
  • .describeSecret(options) ⇒ Promise.<object>
  • .getSecretValue(options) ⇒ Promise.<GetSecretValueResponse>
  • .putSecretValue(options) ⇒ Promise.<PutSecretValueResponse>

new exports.WrappedSecretsManagerClient([options])

WrappedSqsClient constructor.

| Param | Type | Description | | --- | --- | --- | | [options] | object | Options. | | [options.logger] | object | Logger instance (default is global console object). Must have info, error & debug methods | | [options.logInternals] | boolean | Log AWS client internals (default is false). | | [options.config] | object | SecretsManagerClientConfig. |

wrappedSecretsManagerClient.createSecret(options) ⇒ Promise.<CreateSecretResponse>

Create a secret.

Kind: instance method of WrappedSecretsManagerClient
Returns: Promise.<CreateSecretResponse> - Response object.

| Param | Type | Description | | --- | --- | --- | | options | object | Options. | | [options.description] | string | A user-provided description of the secret. | | [options.forceOverwriteReplicaSecret] | boolean | Specifies whether to overwrite a secret with the same name in the destination Region. | | options.name | string | Specifies the friendly name of the new secret. The secret name must be ASCII letters, digits, or the following characters : /_+=.@- | | options.value | string | object | Specifies the value of the secret. | | [options.versionId] | string | A unique identifier for the request. If you repeat the request with the same client request token, but change other parameters, AWS CloudFormation returns an error, indicating that the request is not idempotent. Generated by AWS if not submitted. |

wrappedSecretsManagerClient.deleteSecret(options) ⇒ Promise.<DeleteSecretResponse>

Delete a secret.

Kind: instance method of WrappedSecretsManagerClient
Returns: Promise.<DeleteSecretResponse> - Response object.

| Param | Type | Description | | --- | --- | --- | | options | object | Options. | | options.secretId | string | The ARN or name of the secret to delete. | | [options.recoveryWindowInDays] | string | Specifies the number of days that AWS CloudFormation waits before deleting the secret permanently. You can specify a minimum value of 7 to a maximum value of 30 days. The default value is 30. | | [options.forceDeleteWithoutRecovery] | string | Specifies whether to delete the secret without any recovery window. |

wrappedSecretsManagerClient.describeSecret(options) ⇒ Promise.<object>

Describe a secret.

Kind: instance method of WrappedSecretsManagerClient
Returns: Promise.<object> - Response object (see DescribeSecretCommandOutput).

| Param | Type | Description | | --- | --- | --- | | options | object | Options. | | options.secretId | string | The ARN or name of the secret to describe. |

wrappedSecretsManagerClient.getSecretValue(options) ⇒ Promise.<GetSecretValueResponse>

Get a secret value.

Kind: instance method of WrappedSecretsManagerClient
Returns: Promise.<GetSecretValueResponse> - Response object.

| Param | Type | Description | | --- | --- | --- | | options | object | Options. | | options.secretId | string | The ARN or name of the secret. | | [options.versionId] | string | The unique identifier of the version of the secret that you want to retrieve. |

wrappedSecretsManagerClient.putSecretValue(options) ⇒ Promise.<PutSecretValueResponse>

Put a secret value.

Kind: instance method of WrappedSecretsManagerClient
Returns: Promise.<PutSecretValueResponse> - Response object.

| Param | Type | Description | | --- | --- | --- | | options | object | Options. | | options.secretId | string | The ARN or name of the secret. | | options.value | string | object | Specifies the value of the secret. | | [options.versionId] | string | A unique identifier for the request. If you repeat the request with the same client request token, but change other parameters, AWS CloudFormation returns an error, indicating that the request is not idempotent. Generated by AWS if not submitted. |

wrapped-secrets-manager-client~CreateSecretResponse : object

Kind: inner typedef of wrapped-secrets-manager-client
Properties

| Name | Type | Description | | --- | --- | --- | | arn | string | The Amazon Resource Name (ARN) of the secret. | | name | string | The friendly name of the secret. | | replicationStatus | string | The status of replication for the secret. | | versionId | string | The unique identifier of the version of the secret that was created. |

wrapped-secrets-manager-client~DeleteSecretResponse : object

Kind: inner typedef of wrapped-secrets-manager-client
Properties

| Name | Type | Description | | --- | --- | --- | | arn | string | The ARN of the secret that is scheduled for deletion. | | deletionDate | Date | The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays. | | name | string | The friendly name of the secret that is scheduled for deletion. |

wrapped-secrets-manager-client~GetSecretValueResponse : object

Kind: inner typedef of wrapped-secrets-manager-client
Properties

| Name | Type | Description | | --- | --- | --- | | arn | string | The ARN of the secret. | | createdDate | Date | The date and time that this version of the secret was created. | | name | string | The friendly name of the secret. | | value | string | object | The secret value. | | versionId | string | The unique identifier of this version of the secret. |

wrapped-secrets-manager-client~PutSecretValueResponse : object

Kind: inner typedef of wrapped-secrets-manager-client
Properties

| Name | Type | Description | | --- | --- | --- | | arn | string | The Amazon Resource Name (ARN) of the secret. | | name | string | The friendly name of the secret. | | versionId | string | The unique identifier of the version of the secret. |

See more great templates and other tools on my GitHub Profile!