Skip to content

Commit 1d5e08b

Browse files
DOCSP-17638 Add ADL Actions for the Custom Role Builder (#177)
* DOCSP-17638 Add ADL Actions for the Custom Role Builder * DOCSP-17638 updates for copy review feedback
1 parent 1daf912 commit 1d5e08b

File tree

2 files changed

+51
-13
lines changed

2 files changed

+51
-13
lines changed

source/deployment/deploy-s3.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ Before you begin, you will need to:
2525
- `Install the AWS CLI
2626
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html>`__.
2727
- `Configure the AWS CLI
28-
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html#cli-quick-configuration>`__.
28+
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html#cli-quick-configuration>`__
29+
to access your |aws| account. Alternatively, you must have access to
30+
the |aws| Management Console with permission to create `IAM roles
31+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html>`__.
2932
- *Optional.* :atlas:`Set Up Unified AWS Access
3033
</security/set-up-unified-aws-access>`.
3134

source/index.txt

Lines changed: 47 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,30 +60,65 @@ A database user must have one of the following roles to query an
6060
- A :atlas:`custom role </security-add-mongodb-roles/>` with the
6161
:manual:`find </reference/privilege-actions/>` privilege
6262

63-
.. _atlas-data-lake-prereqs:
63+
.. _atlas-data-lake-actions:
6464

65-
Prerequisites
66-
-------------
65+
Privilege Actions
66+
-----------------
6767

68-
Verify that you meet the following prerequisites before you create a
69-
|data-lake|:
68+
Privilege actions define the operations that you can perform on your
69+
{+dl+}. You can grant the following {+adl+} privileges:
7070

71-
* One or more |aws| |s3| buckets in the same |aws| account.
71+
- When you :atlas:`create or modify </security-add-mongodb-roles/>`
72+
custom roles from the |service| User Interface
73+
- In the ``actions.action`` request body parameter when you
74+
:atlas:`create </reference/api/custom-roles-create-a-role/>` or
75+
:atlas:`update </reference/api/custom-roles-update-a-role/>` a custom
76+
role from the |service| |api|
7277

73-
* An |aws| CLI configured to access your |aws| account. Alternatively,
74-
you must have access to the |aws| Management Console with permission
75-
to create `IAM roles <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html>`__.
78+
.. expression:: sqlGetSchema
7679

77-
.. note:
80+
Retrieve the schema stored for a collection or view using
81+
the :ref:`sqlgetschema-cmd` command.
7882

79-
To prevent excessive charges on your bill, create your |service|
80-
|data-lake| in the same |aws| region as your |s3| data source.
83+
.. expression:: sqlSetSchema
84+
85+
Set or delete the schema for a collection or view using the
86+
:ref:`sqlsetschema-cmd` command.
87+
88+
.. expression:: viewAllHistory
89+
90+
Retrieve details about the queries that were run in the past
91+
24 hours using :ref:`$queryHistory <adl-query-history-stage>`.
92+
93+
.. expression:: outToS3
94+
95+
Write data from any one of the :ref:`supported
96+
<datalake-configuration-file-overview>` {+data-lake-stores+} or
97+
multiple :ref:`supported <datalake-configuration-file-overview>`
98+
{+data-lake-stores+} to your |s3| bucket using :ref:`adl-out-stage`.
99+
100+
.. expression:: storageGetConfig
101+
102+
Retrieve your {+dl+} :ref:`storage configuration
103+
<datalake-configuration-file>` using the :ref:`storageGetConfig
104+
<datalake-getstorageconfig>` command.
105+
106+
.. expression:: storageSetConfig
107+
108+
Set or update your {+dl+} :ref:`storage configuration
109+
<datalake-configuration-file>` using the :ref:`storageSetConfig
110+
<datalake-setstorageconfig>` command.
81111

82112
.. _atlas-data-lake-regions:
83113

84114
{+adl+} Regions
85115
-----------------------
86116

117+
.. note::
118+
119+
To prevent excessive charges on your bill, create your |service|
120+
|data-lake| in the same |aws| region as your |s3| data source.
121+
87122
{+adl+} routes your {+dl+} requests through one of the following
88123
regions:
89124

0 commit comments

Comments
 (0)