Skip to content

doc: DOCSP-53419 Update doc for MongoDB::Atlas::Cluster CFN resource #1439

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
QuiqueSanMongo merged 4 commits into from
Sep 15, 2025
Merged

doc: DOCSP-53419 Update doc for MongoDB::Atlas::Cluster CFN resource #1439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3372d3e
DOCSP-53419-adds Cluster CFN Readme and examples
QuiqueSanMongo Sep 11, 2025
24c824d
Suggestions applied
QuiqueSanMongo Sep 12, 2025
10531e2
Update cfn-resources/cluster/README.md
QuiqueSanMongo Sep 15, 2025
86c60b2
Merge branch 'master' into DOCSP-53419
QuiqueSanMongo Sep 15, 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
20 changes: 14 additions & 6 deletions cfn-resources/cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
# MongoDB::Atlas::Cluster
# MongoDB::Atlas::Cluster CFN resource
Copy link
Copy Markdown
Member

@lantoli lantoli Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think main change in this PR should be about saying that MongoDB::Atlas::Cluster also allows to create Flex clusters, and this is recommended over using MongoDB::Atlas::FlexCluster.

You might want to get some inspiration from the CDK PRs:
https://github.com/mongodb/awscdk-resources-mongodbatlas/pull/493/files
https://github.com/mongodb/awscdk-resources-mongodbatlas/pull/495/files


## Description
Provides a resource for managing [Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-clusters) in AWS Cloud Formation. The resource
lets you create, edit, and delete clusters. The resource requires your Project
ID to perform these actions.

*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the foreseeable future.

*Important:* Use the `MongoDB::Atlas::Cluster` resource instead of the `MongoDB::Atlas::FlexCluster` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource.


Resource for managing [Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-clusters).

## Requirements

Set up an AWS profile to securely give CloudFormation access to your Atlas credentials.
For instructions on setting up a profile, [see here](/README.md#mongodb-atlas-api-keys-credential-management).
To securely give CloudFormation access to your Atlas credentials, you must
set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management).


## Attributes and Parameters
For futher information, see the [resource docs](docs/README.md) section.

See the [resource docs](docs/README.md).

## Cloudformation Examples

See the examples [CFN Template](/examples/cluster/cluster.json) for example resource.
For examples, see the [CFN Template](/examples/cluster/cluster.json) example.
2 changes: 1 addition & 1 deletion examples/cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Step c: Select and activate
Enter the RoleArn that is created in step 1.

Cluster Resource is ready to use.
Your cluster Resource is ready to use.

## Step 2: Create template using [cluster.json](project-cluster.json)
Note: Make sure you are providing appropriate vales for
Expand Down
Loading