doc: DOCSP-53419 Update doc for MongoDB::Atlas::Cluster CFN resource by QuiqueSanMongo · Pull Request #1439 · mongodb/mongodbatlas-cloudformation-resources

QuiqueSanMongo · 2025-09-11T19:00:38Z

Proposed changes

Updates cfn-resources README file
Updates examples/cluster/README file
_Jira ticket: https://jira.mongodb.org/browse/DOCSP-53419

Link to any related issue(s): https://jira.mongodb.org/browse/CLOUDP-286685

Type of change:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as
expected)
This change requires a documentation update
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Manual QA performed:

cfn invoke for each of CRUDL/cfn test
Updated resource in example
Published to AWS private registry
Used the template in example to create and update a stack in AWS
Deleted stack to ensure resources are deleted
Created multiple resources in same stack
Validated in Atlas UI
Included screenshots

Required Checklist:

I have signed the MongoDB CLA
I have added tests that prove my fix is effective or that my feature works
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
For CFN Resources: I have released by changes in the private registry and proved by change
works in Atlas

Further comments

Copilot

Pull Request Overview

This PR updates documentation for the MongoDB Atlas Cluster CloudFormation resource, improving the README files with more comprehensive information about the resource.

Updates the main cluster CFN resource README with detailed attribute descriptions and improved formatting
Adds minor clarification to the cluster example README
Enhances documentation structure to better guide users in understanding and using the cluster resource

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
cfn-resources/cluster/README.md	Comprehensive rewrite adding detailed attribute descriptions, requirements, and improved structure
examples/cluster/README.md	Minor text improvement for clarity

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-11T19:01:34Z

 ## Cloudformation Examples

-See the examples [CFN Template](/examples/cluster/cluster.json) for example resource.
+See the examples [CFN Template](/examples/cluster/README.md) for example resource.


The link points to a README.md file instead of the actual CloudFormation template. Based on the original content, this should link to the JSON template file (e.g., /examples/cluster/cluster.json) rather than the README file.

Suggested change

See the examples [CFN Template](/examples/cluster/README.md) for example resource.

See the examples [CFN Template](/examples/cluster/cluster.json) for example resource.

Copilot · 2025-09-11T19:01:35Z

 ## Attributes and Parameters

-See the [resource docs](docs/README.md).
+* `AdvancedSettings` -  processArgs


The type description 'processArgs' is unclear and inconsistent with other attribute type descriptions. It should specify the actual data type (e.g., 'Object' or 'AdvancedSettings Object') for consistency with other attributes.

Suggested change

* `AdvancedSettings` - processArgs

* `AdvancedSettings` - AdvancedSettings Object

Copilot · 2025-09-11T19:01:35Z

+* `ClusterType` - String
+Configuration of nodes that comprise the cluster.
+
+* `ConnectionStrings` - connectionStrings


The type description 'connectionStrings' should be capitalized to 'ConnectionStrings Object' or similar to maintain consistency with the naming convention used for other complex types in this documentation.

Suggested change

* `ConnectionStrings` - connectionStrings

* `ConnectionStrings` - ConnectionStrings Object

Copilot · 2025-09-11T19:01:35Z

+Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
+
+* `Tags` - Array
+List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.


The description for Tags is incorrect - it appears to be copied from the ReplicationSpecs attribute. Tags should describe key-value pairs for labeling and organizing resources, not cluster region configuration.

Suggested change

List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.

Collection of key-value pairs that you can use to label and organize your cluster resources. Tags help you manage, search, and filter resources within your cloud environment.

ytineo-mongodb

LGTM

Great job!!

marcosuma · 2025-09-12T06:25:36Z

 ## Attributes and Parameters

-See the [resource docs](docs/README.md).
+* `AdvancedSettings` -  processArgs


just curious: what is the purpose of this change? I am thinking that if we do it here, all the other resources will have a different structure

I think more like a question for @lantoli maybe?

I think we can just refer to docs folder as this attribute information seems duplicated with the other content. This is different to Terraform because there is not a doc folder there with all this information

I can point to the resource docs](docs/README.md) file instead. is it OK?

yes, unless we want to change for a reason we can just leave this section as we do it for the other resources. Right?

lantoli · 2025-09-12T07:34:15Z

@@ -1,18 +1,87 @@
-# MongoDB::Atlas::Cluster
+# MongoDB::Atlas::Cluster CFN resource


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

lantoli

LGTM after the last comment is addressed

Co-authored-by: Leo Antoli <430982+lantoli@users.noreply.github.com>

DOCSP-53419-adds Cluster CFN Readme and examples

3372d3e

Copilot AI review requested due to automatic review settings September 11, 2025 19:00

QuiqueSanMongo requested a review from a team as a code owner September 11, 2025 19:00

QuiqueSanMongo requested review from lantoli and marcosuma September 11, 2025 19:01

Copilot AI reviewed Sep 11, 2025

View reviewed changes

ytineo-mongodb approved these changes Sep 11, 2025

View reviewed changes

marcosuma reviewed Sep 12, 2025

View reviewed changes

lantoli reviewed Sep 12, 2025

View reviewed changes

Suggestions applied

24c824d

marcosuma approved these changes Sep 15, 2025

View reviewed changes

lantoli reviewed Sep 15, 2025

View reviewed changes

Comment thread cfn-resources/cluster/README.md Outdated

lantoli approved these changes Sep 15, 2025

View reviewed changes

QuiqueSanMongo and others added 2 commits September 15, 2025 11:14

Update cfn-resources/cluster/README.md

10531e2

Co-authored-by: Leo Antoli <430982+lantoli@users.noreply.github.com>

Merge branch 'master' into DOCSP-53419

86c60b2

QuiqueSanMongo added this pull request to the merge queue Sep 15, 2025

Merged via the queue into master with commit e7b905a Sep 15, 2025
39 checks passed

QuiqueSanMongo deleted the DOCSP-53419 branch September 15, 2025 17:36

	See the examples [CFN Template](/examples/cluster/README.md) for example resource.
	See the examples [CFN Template](/examples/cluster/cluster.json) for example resource.

	* `AdvancedSettings` - processArgs
	* `AdvancedSettings` - AdvancedSettings Object

	* `ConnectionStrings` - connectionStrings
	* `ConnectionStrings` - ConnectionStrings Object

	List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.
	Collection of key-value pairs that you can use to label and organize your cluster resources. Tags help you manage, search, and filter resources within your cloud environment.

		@@ -1,18 +1,87 @@
		# MongoDB::Atlas::Cluster
		# MongoDB::Atlas::Cluster CFN resource

Conversation

QuiqueSanMongo commented Sep 11, 2025

Proposed changes

Type of change:

Manual QA performed:

Required Checklist:

Further comments

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

ytineo-mongodb left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcosuma Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

marcosuma Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

lantoli Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

QuiqueSanMongo Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

marcosuma Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

lantoli Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lantoli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ytineo-mongodb left a comment •

edited

Loading