Skip to content

Commit 4e279cd

Browse files
committed
add description field
1 parent 27efdb7 commit 4e279cd

File tree

6 files changed

+27
-5
lines changed

6 files changed

+27
-5
lines changed

cfn-resources/resource-policy/cmd/resource/mappings.go

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,19 @@
1515
package resource
1616

1717
import (
18-
"github.com/mongodb/mongodbatlas-cloudformation-resources/util"
1918
"go.mongodb.org/atlas-sdk/v20250312002/admin"
19+
20+
"github.com/mongodb/mongodbatlas-cloudformation-resources/util"
2021
)
2122

2223
func NewResourcePolicyCreateReq(model *Model) *admin.ApiAtlasResourcePolicyCreate {
2324
if model == nil {
2425
return nil
2526
}
2627
return &admin.ApiAtlasResourcePolicyCreate{
27-
Name: *model.Name,
28-
Policies: *modelPoliciesToSDKPolicies(model.Policies),
28+
Name: *model.Name,
29+
Description: *&model.Description,
30+
Policies: *modelPoliciesToSDKPolicies(model.Policies),
2931
}
3032
}
3133

@@ -42,8 +44,9 @@ func NewResourcePolicyUpdateReq(model *Model) *admin.ApiAtlasResourcePolicyEdit
4244
return nil
4345
}
4446
return &admin.ApiAtlasResourcePolicyEdit{
45-
Name: model.Name,
46-
Policies: modelPoliciesToSDKPolicies(model.Policies),
47+
Name: model.Name,
48+
Description: model.Description,
49+
Policies: modelPoliciesToSDKPolicies(model.Policies),
4750
}
4851
}
4952

cfn-resources/resource-policy/cmd/resource/model.go

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

cfn-resources/resource-policy/docs/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ To declare this entity in your AWS CloudFormation template, use the following sy
1515
"<a href="#createdbyuser" title="CreatedByUser">CreatedByUser</a>" : <i><a href="apiatlasusermetadata.md">ApiAtlasUserMetadata</a></i>,
1616
"<a href="#lastupdatedbyuser" title="LastUpdatedByUser">LastUpdatedByUser</a>" : <i><a href="apiatlasusermetadata.md">ApiAtlasUserMetadata</a></i>,
1717
"<a href="#name" title="Name">Name</a>" : <i>String</i>,
18+
"<a href="#description" title="Description">Description</a>" : <i>String</i>,
1819
"<a href="#orgid" title="OrgId">OrgId</a>" : <i>String</i>,
1920
"<a href="#policies" title="Policies">Policies</a>" : <i>[ <a href="apiatlaspolicy.md">ApiAtlasPolicy</a>, ... ]</i>,
2021
"<a href="#profile" title="Profile">Profile</a>" : <i>String</i>
@@ -30,6 +31,7 @@ Properties:
3031
<a href="#createdbyuser" title="CreatedByUser">CreatedByUser</a>: <i><a href="apiatlasusermetadata.md">ApiAtlasUserMetadata</a></i>
3132
<a href="#lastupdatedbyuser" title="LastUpdatedByUser">LastUpdatedByUser</a>: <i><a href="apiatlasusermetadata.md">ApiAtlasUserMetadata</a></i>
3233
<a href="#name" title="Name">Name</a>: <i>String</i>
34+
<a href="#description" title="Description">Description</a>: <i>String</i>
3335
<a href="#orgid" title="OrgId">OrgId</a>: <i>String</i>
3436
<a href="#policies" title="Policies">Policies</a>: <i>
3537
- <a href="apiatlaspolicy.md">ApiAtlasPolicy</a></i>
@@ -64,6 +66,16 @@ _Type_: String
6466

6567
_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
6668

69+
#### Description
70+
71+
Description of the Atlas resource policy..
72+
73+
_Required_: No
74+
75+
_Type_: String
76+
77+
_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
78+
6779
#### OrgId
6880

6981
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.

cfn-resources/resource-policy/mongodb-atlas-resourcepolicy.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@
7878
"type": "string",
7979
"description": "Human-readable label that describes the atlas resource policy."
8080
},
81+
"Description": {
82+
"type": "string",
83+
"description": "Description of the Atlas resource policy.."
84+
},
8185
"OrgId": {
8286
"type": "string",
8387
"maxLength": 24,

cfn-resources/resource-policy/test/inputs_1_create.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"Name": "Name",
33
"OrgId": "OrgId",
4+
"Description": "test description",
45
"Id": "",
56
"Profile": "default",
67
"Policies": [

cfn-resources/resource-policy/test/inputs_1_update.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"Name": "Name",
33
"OrgId": "OrgId",
4+
"Description": "test description updated",
45
"Id": "",
56
"Profile": "default",
67
"Policies": [

0 commit comments

Comments
 (0)