Skip to content

doc: DOCSP-53435: Update flex-cluster README #495

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 3 commits into from
Sep 12, 2025
Merged

doc: DOCSP-53435: Update flex-cluster README #495

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
451dbaf
(DOCSP-53435) Update flex-cluster README
antellezr-mdb Sep 11, 2025
ee2393d
(DOCSP-53435) Add recommendation to use the CfnCluster resource
antellezr-mdb Sep 11, 2025
c158f2f
Update src/l1-resources/flex-cluster/README.md
antellezr-mdb Sep 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
8 changes: 6 additions & 2 deletions src/l1-resources/flex-cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ The official [MongoDB Atlas](https://www.mongodb.com/) AWS CDK resource for Node

## Description

The flex cluster resource provides access to your flex cluster configurations. The resource lets you 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).
The flex cluster resource provides access to your flex cluster 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).

*Important:* Use the `CfnCluster` resource instead of the `CfnFlexCluster` resource to create and manage flex clusters. `CfnCluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`CfnCluster` README](../cluster/README.md).

## MongoDB Atlas API Docs

For more information about the API refer to: [API Endpoints](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters)

## Usage

In order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the [AWS CLI](https://aws.amazon.com/cli/) using the following command:
In order to use this library, you must activate the following AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or through the [AWS CLI](https://aws.amazon.com/cli/) using the following command:

```sh
aws cloudformation activate-type \
Expand Down Expand Up @@ -59,6 +61,8 @@ const flexClusterRes = new CfnFlexCluster(this, 'FlexClusterResource', {
});
```

*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the forseeable future.

## Feedback

This library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation] project based on the API schema published for `MongoDB::Atlas::FlexCluster`.
Expand Down
Loading