Skip to main content

MongoDB Atlas AWS CDK Resources

Code Health Package CDK npm version PyPI version NuGet version Maven Central Go Reference

View on Construct Hub

Use MongoDB Atlas AWS CDK (or Cloud Development Kit) constructs to manage MongoDB Atlas. The AWS CDK is a framework for defining infrastructure as code (IaC). It allows developers to write code in their preferred programming language, such as TypeScript for example, to define and deploy infrastructure. AWS CDK gets synthesized down into AWS CloudFormation templates at deployment so users no longer have to write or maintain YAML/JSON based CloudFormation templates.

Available Packages

NPM

The npm package is available at awscdk-resources-mongodbatlas

npm i awscdk-resources-mongodbatlas

PyPI

The PyPI package is available at awscdk-resources-mongodbatlas

pip install awscdk-resources-mongodbatlas

Nuget

The Nuget package is available at MongoDB.AWSCDKResourcesMongoDBAtlas

dotnet add package MongoDB.AWSCDKResourcesMongoDBAtlas --version 1.0.0

Maven

The Maven package is available at awscdk-resources-mongodbatlas

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>awscdk-resources-mongodbatlas</artifactId>
    <version>1.0.0</version>
</dependency>

Go

The go package is generated into the github.com/mongodb/awscdk-resources-mongodbatlas-go package.

go get github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas

Available Constructors

MongoDB Atlas AWS CDK Resources provides L1, L2 and L3 CDK constructors. Please, have a look at README.md for a full lists of constructors and examples.

Getting Started

See the cdk examples for how to setup prerequisites & get started with your first cluster, using our AWS CDK sample code. We also provide a quick guide on How to Deploy MongoDB Atlas with AWS CDK in TypeScript.

Support, Bugs, Feature Requests

Feature requests can be submitted at the MongoDB feedback portal - select Atlas -> infra-as-code as the category or vote for an already suggested feature.

Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions within the Atlas UI. In addition, support questions submitted under the Issues section of this repo are also being monitored. Bugs should be filed under the Issues section of this repo.

MongoDB Atlas API Keys Credential Management

Atlas API keys Configuration are required for both CloudFormation and CDK resources, and this Atlas API key pair are provided as input by the use of a Profile.

AWS CloudFormation limits Third Parties from using non-AWS API Keys as either hardcoded secrets in CloudFormation templates or via CDK, hence we now require all the users store MongoDB Atlas API Keys via AWS Secrets Manager.

NOTE: the process for configuring the PROFILE is the same and is required both for CloudFormation and CDK

1. Configure your MongoDB Atlas API Keys

You'll need to generate an API key pair (public and private keys) for your Atlas organization and configure them to grant CloudFormation access to your Atlas project. Refer to the Atlas documentation for detailed instructions.

2. Configure your Profile

To use Atlas CloudFormation resources, you must configure a "profile" with your API keys using AWS Secrets Manager.

The secret should follow this format:

SecretName: cfn/atlas/profile/{ProfileName}
SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

To create a new secret for a default profile, use the PROFILE SECRET TEMPLATE file provided in this repository.

Here are some examples of how to use this template:

example 1:

ProfileName: default
SecretName: cfn/atlas/profile/default
SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

example 2:

ProfileName: testProfile
SecretName: cfn/atlas/profile/testProfile
SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

Contributing

See our CONTRIBUTING.md guide.

Issues

Autoclose stale issues and PRs

  • After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: This issue/PR has gone 5 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 5 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!
  • After 5 more days of no activity we automatically close the issue/PR.

One-click reproducible issues principle

Our support will prioritise issues that contain all the required information that follows the following principles:

  • We should be able to make no changes to your provided script and successfully run a local execution reproducing the issue.

    • This means that you should kindly provide all the required instructions. This includes but not limited to:

      • AWS CDK package version used to reproduce the issue
      • CFN resource version and AWS region used to reproduce the issue
    • Issues that cannot be properly reproduced will be de-prioritised in favour of the ones that succeed.

  • Before opening an issue, you have to try to specifically isolate it to the CDK MongoDB Atlas constructor by removing as many dependencies as possible. If the issue only happens with other dependencies, then:

    • If other CDK constructors are required, please make sure you also include those. Same "one-click reproducible issue" principle applies.
    • If external components are required to replicate it, please make sure you also provides instructions on those parts.

Metadata

Release files for awscdk-resources-mongodbatlas 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for awscdk-resources-mongodbatlas 4.1.0
File Size Uploaded Provenance Actions
awscdk_resources_mongodbatlas-4.1.0.tar.gz 840.0 kB With provenance Details for awscdk_resources_mongodbatlas-4.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for awscdk-resources-mongodbatlas 4.1.0
File Interpreter ABI Platform Actions
awscdk_resources_mongodbatlas-4.1.0-py3-none-any.whl Python 3 none any Details for awscdk_resources_mongodbatlas-4.1.0-py3-none-any.whl

Total release size: 1.7 MB

Release files / awscdk_resources_mongodbatlas-4.1.0.tar.gz

Download URL awscdk_resources_mongodbatlas-4.1.0.tar.gz
Size 840.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b9ac1979d8ce463d0815125412e6c9a1d8867c716e6d4ffb116021f597f88a7f
BLAKE2b-256 checksum
How to use checksums
3c91b6b3bceb26dcb0a074bfe570b96d11ca1ac352408eddc53c002dda78345c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / awscdk_resources_mongodbatlas-4.1.0-py3-none-any.whl

Download URL awscdk_resources_mongodbatlas-4.1.0-py3-none-any.whl
Size 837.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f27ec2a0d76360af5adcea6c500041fb49e748acf9bbb20c292dcf667d38229d
BLAKE2b-256 checksum
How to use checksums
3a5eee78c97a8899c003289bdb49b9b706599b00f76a671ee56ea1ee1ad01d43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Security for awscdk-resources-mongodbatlas 4.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for awscdk_resources_mongodbatlas-4.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page