Skip to content

doc: Updates README with details on AWS Secrets Manager profile naming for CloudFormation #1307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 18, 2025
Merged

doc: Updates README with details on AWS Secrets Manager profile naming for CloudFormation #1307

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c1cc76
doc: Update README with details on AWS Secrets Manager profile naming…
EspenAlbert Mar 17, 2025
b1db693
doc: Clarify requirement for secret existence in the same AWS account…
EspenAlbert Mar 17, 2025
caf034f
chore: fix lint errors
EspenAlbert Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}
```

To create a new secret for a default profile, use the [PROFILE SECRET TEMPLATE](/examples/profile-secret.yaml) file provided in this repository.
The secret must exist in the same AWS account and AWS region where the Cloudformation stack is run.

Here are some examples of how to use this template:

Expand Down
2 changes: 2 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ You must [configure API keys](https://www.mongodb.com/docs/atlas/configure-api-a
### CloudFormation Profile
You should create a profile in the AWS Secrets Manager that contains the MongoDB Atlas Programmatic API Key.

The secret must be named `cfn/atlas/profile/{ProfileName}` and exist in the same AWS account and AWS region where the Cloudformation stack is run.

Use [this template](profile-secret.yaml) to create a [new CloudFormation stack](https://console.aws.amazon.com/cloudformation/home#/stacks/create) for the default profile that all resources attempt to use unless you specify a different profile.

### Configure the IAM Execution Role
Expand Down
Loading