Skip to content

Commit e7b905a

Browse files
doc: DOCSP-53419 Update doc for MongoDB::Atlas::Cluster CFN resource (#1439)
Co-authored-by: Leo Antoli <430982+lantoli@users.noreply.github.com>
1 parent 40360f1 commit e7b905a

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

cfn-resources/cluster/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# MongoDB::Atlas::Cluster
1+
# MongoDB::Atlas::Cluster CFN resource
22

33
## Description
4+
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
5+
lets you create, edit, and delete clusters. The resource requires your Project
6+
ID to perform these actions.
7+
8+
*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the foreseeable future.
9+
10+
*Important:* Use the `MongoDB::Atlas::Cluster` resource instead of the `MongoDB::Atlas::FlexCluster` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource.
11+
412

5-
Resource for managing [Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-clusters).
613

714
## Requirements
815

9-
Set up an AWS profile to securely give CloudFormation access to your Atlas credentials.
10-
For instructions on setting up a profile, [see here](/README.md#mongodb-atlas-api-keys-credential-management).
16+
To securely give CloudFormation access to your Atlas credentials, you must
17+
set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management).
18+
1119

1220
## Attributes and Parameters
21+
For futher information, see the [resource docs](docs/README.md) section.
1322

14-
See the [resource docs](docs/README.md).
1523

1624
## Cloudformation Examples
1725

18-
See the examples [CFN Template](/examples/cluster/cluster.json) for example resource.
26+
For examples, see the [CFN Template](/examples/cluster/cluster.json) example.

examples/cluster/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Step c: Select and activate
1010
Enter the RoleArn that is created in step 1.
1111

12-
Cluster Resource is ready to use.
12+
Your cluster Resource is ready to use.
1313

1414
## Step 2: Create template using [cluster.json](project-cluster.json)
1515
Note: Make sure you are providing appropriate vales for

0 commit comments

Comments
 (0)