-
Notifications
You must be signed in to change notification settings - Fork 39
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.
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
Changes from all commits
b816c6c
df778ac
90fe1e1
71d07d1
7ec63f8
5b3fc92
a514b82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,6 +60,20 @@ Note these are also hosted on AWS CloudFormation Public Registry under Third Par | |
| | 47 | stream-connection |  | [example](../examples/atlas-streams/stream-connection/stream-connection.json) | [./stream-connection/test](./stream-connection/test) | ||
| |47 | resource-policy |  | [example](../examples/resource-policy/resource-policy.json) | [./resource-policy/test](./resource-policy/test) | ||
|
|
||
| ## Resource Import Operations | ||
marcosuma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed, thanks!
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @oarbusi should we also mention that Import is available in the main readme and link to here, like Agustin suggested?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done in a514b82 |
||
|
|
||
| ### Import Requirements and Considerations | ||
marcosuma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. For more datails on when the update is run, please see [Create a stack from existing resources using the AWS Management Console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-new-stack.html#resource-import-new-stack-console) or [Import an existing resource into a stack using the AWS Management Console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-existing-stack.html#resource-import-existing-stack-console) or | ||
oarbusi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 3. **Outputs Restrictions**: You cannot modify or add [Outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) to the template during the import operation. 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 | | ||
|
|
||
There was a problem hiding this comment.
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.