Skip to content

Commit 863fe7d

Browse files
authored
feat: Adds description field to CfnResourcePolicyProps & removes note for private preview (#439)
1 parent 1846853 commit 863fe7d

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

API.md

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/l1-resources/resource-policy/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

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

5-
> **NOTE**:
6-
> - **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.**
7-
85
> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `MongoDB::Atlas::ResourcePolicy`.
96
[L1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html
107
[AWS CloudFormation Registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html

src/l1-resources/resource-policy/index.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ export interface CfnResourcePolicyProps {
2929
*/
3030
readonly name: string;
3131

32+
/**
33+
* Description of the Atlas resource policy.
34+
*
35+
* @schema CfnResourcePolicyProps#Description
36+
*/
37+
readonly description?: string;
38+
3239
/**
3340
* 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.
3441
*
@@ -65,6 +72,7 @@ export function toJson_CfnResourcePolicyProps(
6572
CreatedByUser: toJson_ApiAtlasUserMetadata(obj.createdByUser),
6673
LastUpdatedByUser: toJson_ApiAtlasUserMetadata(obj.lastUpdatedByUser),
6774
Name: obj.name,
75+
Description: obj.description,
6876
OrgId: obj.orgId,
6977
Policies: obj.policies?.map((y) => toJson_ApiAtlasPolicy(y)),
7078
Profile: obj.profile,

0 commit comments

Comments
 (0)