This guide assumes you have read Configuring and using secrets, which covers how the platform manages secrets and how to access them in your flows.
This page specifically details storing secrets in AWS Secrets Manager on your own AWS account.
This page specifically details storing secrets in AWS Secrets Manager on your own AWS account.
Granting the platform access to your secrets
Admin only1
Add secrets in AWS Secrets Manager
Add secrets to AWS Secrets Manager as you normally would. Store each secret as a JSON object of key-value pairs:You can choose any name for the secret. Your flows reference the secret by this name.
2
Tag the secret for your deployment
In AWS Secrets Manager, add the following tag to each secret you want the platform to access:
- Key:
outerbounds.com/accessible-by-deployment - Value: Your deployment name
Using secrets
Access tagged secrets in your flows with the@secrets decorator, exactly as described in Configuring secrets. The difference is the source string: AWS Secrets Manager secrets are referenced by their secret name directly, without the outerbounds. prefix.
For example, to retrieve the two keys stored in a secret named basic-secret-kv:
Using plaintext secrets
In some cases, you might not be able to store a secret as a JSON object. For a secret that contains an arbitrary string, expose it through an environment variable by setting thejson option to False:
my-secret-plain becomes my_secret_plain.