feat: Update CfnCluster with flex support #494
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for FLEX provider in MongoDB Atlas clusters by updating the CfnCluster resource definition. The main purpose is to enable users to create flex clusters through the CDK construct.
- Added FLEX as a new provider option in the AdvancedRegionConfigProviderName enum
- Made Tag interface properties required (key and value are no longer optional)
- Updated documentation with example usage of flex clusters
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/l1-resources/cluster/index.ts | Added FLEX enum value and made Tag properties required |
| src/l1-resources/cluster/README.md | Added example showing how to create a flex cluster |
| TESTING.md | Updated testing instructions for better clarity |
| API.md | Generated API documentation reflecting the FLEX enum addition |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ``` | ||
|
|
||
| You can also create a flex cluster using CfnCluster, for example: |
There was a problem hiding this comment.
example of creating a flex cluster with CfnCluster so docs team can update this README file to reference it
| 4. Add a reference to the previous file in the `dependencies` section in `package.json` instead of using a published version, for example: | ||
| ``` | ||
| "awscdk-resources-mongodbatlas": "file:../dist/js/[email protected]" | ||
| ``` |
There was a problem hiding this comment.
I think this is better and you can do changes in our provider and generate the file again without having to copy it over and over again
| ``` | ||
| 5. Import your CDK construct in a testing project. | ||
| 6. Use the construct in your app with appropriate parameters. | ||
| - [Optional, not applicable for L2/L3 constructs] If you need help getting test parameters to use with the constructs you can use `./cfn-resources/cfn-testing-helper.sh`. Refer “Getting test parameters” for creating a stack here for details. |
Proposed changes
Update CfnCluster with flex support
Jira ticket: CLOUDP-342591
Please include a summary of the fix/feature/change, including any relevant motivation and context.
Link to any related issue(s):
Type of change:
expected)
Required Checklist:
make fmtand formatted my codeFurther comments