Skip to content

feat: Adds description field to CfnResourcePolicyProps & removes note for private preview #439

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
Apr 16, 2025
Merged

feat: Adds description field to CfnResourcePolicyProps & removes note for private preview #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc653b4
min
maastha Apr 15, 2025
9ac4ba2
min
maastha Apr 15, 2025
6363f97
API.md
maastha Apr 15, 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
13 changes: 13 additions & 0 deletions API.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions src/l1-resources/resource-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

The official [MongoDB Atlas](https://www.mongodb.com/) AWS CDK resource for Node.js.

> **NOTE**:
> - **Resource Policies is currently in Public Preview, if you want to use it, contact [MongoDB Support](https://www.mongodb.com/services/support) to enable `Atlas Resource Policies` Preview Feature in your organization.**

> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `MongoDB::Atlas::ResourcePolicy`.
[L1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html
[AWS CloudFormation Registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html
Expand Down
8 changes: 8 additions & 0 deletions src/l1-resources/resource-policy/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ export interface CfnResourcePolicyProps {
*/
readonly name: string;

/**
* Description of the Atlas resource policy.
*
* @schema CfnResourcePolicyProps#Description
*/
readonly description?: string;

/**
* Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
*
Expand Down Expand Up @@ -65,6 +72,7 @@ export function toJson_CfnResourcePolicyProps(
CreatedByUser: toJson_ApiAtlasUserMetadata(obj.createdByUser),
LastUpdatedByUser: toJson_ApiAtlasUserMetadata(obj.lastUpdatedByUser),
Name: obj.name,
Description: obj.description,
OrgId: obj.orgId,
Policies: obj.policies?.map((y) => toJson_ApiAtlasPolicy(y)),
Profile: obj.profile,
Expand Down
Loading