Skip to content

doc: Import support documentation and considerations #1305

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 7 commits into from
Mar 13, 2025
Merged

doc: Import support documentation and considerations #1305

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b816c6c
import mentions
oarbusi Mar 11, 2025
df778ac
mention update op is required and all MDB resources support import
oarbusi Mar 11, 2025
90fe1e1
remove import limitation in main readme
oarbusi Mar 11, 2025
71d07d1
link to main import doc
oarbusi Mar 11, 2025
7ec63f8
detail on update
oarbusi Mar 11, 2025
5b3fc92
Update cfn-resources/README.md
oarbusi Mar 11, 2025
a514b82
import in main readme
oarbusi Mar 12, 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
12 changes: 12 additions & 0 deletions cfn-resources/README.md
View file
Open in desktop
Copy link
Collaborator Author

@oarbusi 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.

Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,18 @@ Note these are also hosted on AWS CloudFormation Public Registry under Third Par
| 47 | stream-connection | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/atlas-streams/stream-connection/stream-connection.json) | [./stream-connection/test](./stream-connection/test)
|47 | resource-policy | ![Build](https://img.shields.io/badge/Beta-yellow) | [example](../examples/resource-policy/resource-policy.json) | [./resource-policy/test](./resource-policy/test)

## Resource Import Operations

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:

### Import Requirements and Considerations

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. **Outputs Restrictions**: As part of the import operation, you cannot modify or add [Outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) to the template. However, you can add outputs after the import is complete.

For more details, refer to the [official AWS Resource Import documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html).

Legend
---
| Badge | Meaning |
Expand Down
Loading