doc: Import support documentation and considerations #1305

oarbusi · 2025-03-11T08:41:42Z

Proposed changes

Documentation changes to add information on the Import functionality

Link to any related issue(s): CLOUDP-303586

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.

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

oarbusi · 2025-03-11T09:54:52Z

cfn-resources/README.md

All the resources we have support import because all resources have full CRUD support.

cfn-resources/README.md

marcosuma · 2025-03-11T14:39:25Z

cfn-resources/README.md

+
+1. **DeletionPolicy Attribute**: Your resource template must include the [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) attribute in order to specify what happens to the resource when it is removed from the stack.
+
+2. **UPDATE Operation Required**: The import operation executes the UPDATE operation behind the scenes. Therefore, UPDATE functionality must be properly implemented for the resource type to support import.


thank you, the nit I have is that this should be linked to some AWS documentation or at least specify that it's how AWS CFN works

Added some link explaining the import flow where they explain the change set being created and when it is executed

marcosuma

overall LGTM, just a minor feedback on adding a link

marcosuma · 2025-03-11T14:41:20Z

@oarbusi let's get a docs team review on this

AgustinBettati · 2025-03-11T14:53:47Z

cfn-resources/README.md


+## Resource Import Operations
+
+All MongoDB Atlas AWS CloudFormation resources support the import operation, allowing you to bring existing Atlas resources under CloudFormation management. When importing resources, please consider the following:


Our main README file calls out import as a limitation: https://github.com/mongodb/mongodbatlas-cloudformation-resources?tab=readme-ov-file#limitations

We can definitely adjust that content, also thinking if we do a brief mention of import functionality in the main readme and reference here for more visibility.

Addressed, thanks!

@oarbusi should we also mention that Import is available in the main readme and link to here, like Agustin suggested?

done in a514b82

cfn-resources/README.md

Co-authored-by: lmkerbey-mdb <[email protected]>

oarbusi · 2025-03-13T08:20:24Z

Merging, docs said LGTM privately

import mentions

b816c6c

oarbusi requested a review from a team as a code owner March 11, 2025 08:41

oarbusi commented Mar 11, 2025

View reviewed changes

cfn-resources/README.md

Copy link

Collaborator Author

oarbusi Mar 11, 2025

Choose a reason for hiding this comment

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

All the resources we have support import because all resources have full CRUD support.

marcosuma reviewed Mar 11, 2025

View reviewed changes

cfn-resources/README.md Show resolved Hide resolved

marcosuma reviewed Mar 11, 2025

View reviewed changes

cfn-resources/README.md Show resolved Hide resolved

mention update op is required and all MDB resources support import

df778ac

marcosuma reviewed Mar 11, 2025

View reviewed changes

AgustinBettati reviewed Mar 11, 2025

View reviewed changes

oarbusi added 3 commits March 11, 2025 16:06

remove import limitation in main readme

90fe1e1

link to main import doc

71d07d1

detail on update

7ec63f8

lmkerbey-mdb suggested changes Mar 11, 2025

View reviewed changes

cfn-resources/README.md Outdated Show resolved Hide resolved

cfn-resources/README.md Show resolved Hide resolved

Update cfn-resources/README.md

5b3fc92

Co-authored-by: lmkerbey-mdb <[email protected]>

marcosuma approved these changes Mar 12, 2025

View reviewed changes

import in main readme

a514b82

lantoli approved these changes Mar 13, 2025

View reviewed changes

oarbusi merged commit 9ccfdae into master Mar 13, 2025
35 checks passed

oarbusi deleted the CLOUDP-303586 branch March 13, 2025 08:20


		1. DeletionPolicy Attribute: Your resource template must include the [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) attribute in order to specify what happens to the resource when it is removed from the stack.

		2. UPDATE Operation Required: The import operation executes the UPDATE operation behind the scenes. Therefore, UPDATE functionality must be properly implemented for the resource type to support import.


		## Resource Import Operations

		All MongoDB Atlas AWS CloudFormation resources support the import operation, allowing you to bring existing Atlas resources under CloudFormation management. When importing resources, please consider the following:

doc: Import support documentation and considerations #1305

doc: Import support documentation and considerations #1305

Uh oh!

Conversation

oarbusi commented Mar 11, 2025

Proposed changes

Type of change:

Required Checklist:

Further comments

Uh oh!

oarbusi Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

marcosuma Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

oarbusi Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

marcosuma left a comment

Choose a reason for hiding this comment

Uh oh!

marcosuma commented Mar 11, 2025

Uh oh!

AgustinBettati Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

oarbusi Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

marcosuma Mar 12, 2025 • 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!

oarbusi Mar 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

oarbusi commented Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

marcosuma Mar 12, 2025 •

edited

Loading