-
Notifications
You must be signed in to change notification settings - Fork 42
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.
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
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,33 @@ | ||
| # MongoDB::Atlas::Cluster | ||
| # MongoDB::Atlas::Cluster CFN resource | ||
|
|
||
| ## 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. | ||
|
|
||
| *Important:* `MongoDB::Atlas::Cluster` supports Flex Clusters, and all future | ||
| updates for creating and managing Flex Clusters will be exclusively available | ||
| through this resource. | ||
|
|
||
| *Important:* We recommend using `MongoDB::Atlas::Cluster` to create and manage | ||
| Flex clusters instead of the `MongoDB::Atlas::FlexCluster` as future upgrades | ||
| will only be available through this resource. | ||
|
|
||
| *Important:* Cluster upgrades to and from Flex Clusters are currently | ||
| unavailable but are planned for future development. | ||
|
QuiqueSanMongo marked this conversation as resolved.
Outdated
|
||
|
|
||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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