Skip to content

Commit

Permalink
Apply suggestions from Clayton's code review
Browse files Browse the repository at this point in the history
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
  • Loading branch information
hainenber and clayton-cornell committed May 8, 2024
1 parent ee0a03b commit 68ec808
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/sources/reference/components/remote.aws.secrets_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@ title: remote.aws.secrets_manager

# remote.aws.secret_manager

`remote.aws.secrets_manager` securely exposes value of secrets located in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to other components.
By default, the secret would be fetched one time only at startup. If configured, the secret will be polled for changes so that the most recent value is always available.
`remote.aws.secrets_manager` securely exposes the secrets located in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to other components.
By default, the secret is fetched once only at startup. If configured, the secret is polled for changes so that the most recent value is always available.

Beware that this could incur cost due to frequent API calls.
{{< admonition type="note" >}}
The polling for changes could incur costs due to frequent API calls.
{{< /admonition >}}

Multiple `remote.aws.secrets_manager` components can be specified using different name
labels. By default, [AWS environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) are used to authenticate against AWS. The `key` and `secret` arguments inside `client` blocks can be used to provide custom authentication.
You can specify multiple `remote.aws.secrets_manager` components by giving them different labels.
By default, [AWS environment variables][] are used to authenticate against AWS.
For custom authentication, you can use the `key` and `secret` arguments inside `client` blocks.

[AWS environment variables]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html

## Usage

Expand All @@ -35,7 +40,7 @@ Name | Type | Description

Hierarchy | Name | Description | Required
----------|------------|----------------------------------------------------|---------
client | [client][] | Additional options for configuring the AWS client. | no
client | [client][] | Additional AWS client configuration options. | no

[client]: #client-block

Expand Down Expand Up @@ -64,7 +69,7 @@ The `data` field contains a mapping from data field names to values.

## Component health

Instances of `remote.aws.secrets_manager` report as healthy if most recent fetch of stored secrets was successful.
Instances of `remote.aws.secrets_manager` report as healthy if the most recent fetch of stored secrets was successful.

## Debug information

Expand Down

0 comments on commit 68ec808

Please sign in to comment.