Skip to content

Commit 40360f1

Browse files
authored
doc: Update doc for MongoDB::Atlas::FlexCluster CFN resource (#1441)
1 parent 7df799f commit 40360f1

2 files changed

Lines changed: 29 additions & 4 deletions

File tree

cfn-resources/flex-cluster/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,21 @@
22

33
## Description
44

5-
Resource for managing [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).
5+
The flex cluster resource provides access to your [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters) configurations and enables you to create, edit, and delete flex clusters. For more information, see [The MongoDB Atlas Flex Tier](https://www.mongodb.com/company/blog/product-release-announcements/dynamic-workloads-predictable-costs-mongodb-atlas-flex-tier).
6+
7+
*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the foreseeable future.
8+
9+
*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. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).
610

711
## Requirements
812

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).
13+
To securely give CloudFormation access to your Atlas credentials, you must
14+
set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management).
1115

1216
## Attributes and Parameters
1317

1418
See the [resource docs](docs/README.md).
1519

1620
## Cloudformation Examples
1721

18-
See the examples [CFN Template](/examples/flex-cluster/flex-cluster.json) for example resource.
22+
See the examples [CFN Template](/examples/flex-cluster/README.md) for example resource.

examples/flex-cluster/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# How to create a MongoDB::Atlas::FlexCluster
2+
3+
## Step 1: Activate the cluster resource in cloudformation
4+
Step a: Create Role using [execution-role.yaml](https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/examples/execution-role.yaml) in CFN resources folder.
5+
6+
Step b: Search for Mongodb::Atlas::FlexCluster resource.
7+
8+
(CloudFormation > Public extensions > choose 'Third party' > Search with " Execution name prefix = MongoDB " )
9+
Step c: Select and activate
10+
Enter the RoleArn that is created in step 1.
11+
12+
Your FlexCluster Resource is ready to use.
13+
14+
## Step 2: Create template using [flex-cluster.json](flex-cluster.json)
15+
Note: Make sure you are providing appropriate values for:
16+
1. ProjectId
17+
2. ClusterName
18+
3. BackingProviderName: AWS, GCP or AZURE
19+
4. RegionName
20+
5. Profile (optional)
21+
6. TerminationProtectionEnabled (optional)

0 commit comments

Comments
 (0)