Skip to content

Commit 00bb531

Browse files
committed
doc: Update descriptions for Collection and DB properties to clarify usage of empty strings
1 parent 1839be4 commit 00bb531

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

cfn-resources/custom-db-role/docs/resource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To declare this entity in your AWS CloudFormation template, use the following sy
2828

2929
#### Collection
3030

31-
Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
31+
Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all collections.
3232

3333
_Required_: No
3434

@@ -38,7 +38,7 @@ _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormati
3838

3939
#### DB
4040

41-
Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
41+
Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all databases.
4242

4343
_Required_: No
4444

cfn-resources/custom-db-role/mongodb-atlas-customdbrole.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@
2020
"properties": {
2121
"Collection": {
2222
"type": "string",
23-
"description": "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set \"actions.resources.cluster\" : true, MongoDB Cloud ignores this parameter."
23+
"description": "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set \"actions.resources.cluster\" : true, MongoDB Cloud ignores this parameter. Use the empty string (\"\") to allow an action on all collections."
2424
},
2525
"DB": {
2626
"type": "string",
27-
"description": "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set \"actions.resources.cluster\" : true, MongoDB Cloud ignores this parameter."
27+
"description": "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set \"actions.resources.cluster\" : true, MongoDB Cloud ignores this parameter. Use the empty string (\"\") to allow an action on all databases."
2828
},
2929
"Cluster": {
3030
"type": "boolean",

0 commit comments

Comments
 (0)