Skip to content

Commit ceffe1f

Browse files
authored
(DOCSP-41303) documents aws iam user auth (#142)
* (DOCSP-41303) documents aws iam user auth * (DOCSP-41303) copy feedback * (DOCSP-41303) copy feedback round two * (DOCSP-41303) pushing changes
1 parent da90e1e commit ceffe1f

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

source/atlasdatabaseuser-custom-resource.txt

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,27 @@ specification with |oidc|.
275275
username: my-oidc-group-id/my-idp-group-name
276276
oidcAuthType: IDP_GROUP
277277

278+
Database User with |aws| |iam| Authentication
279+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
280+
281+
The following example shows an ``AtlasDatabaseUser`` custom resource
282+
specification with |aws| |iam|.
283+
284+
.. code-block:: sh
285+
286+
apiVersion: atlas.mongodb.com/v1
287+
kind: AtlasDatabaseUser
288+
metadata:
289+
name: my-database-user
290+
spec:
291+
username: arn:aws:iam::123456789012:user/johndoe
292+
roles:
293+
- roleName: "readWriteAnyDatabase"
294+
databaseName: "admin"
295+
projectRef:
296+
name: my-project
297+
awsIAMType: USER
298+
278299
Parameters
279300
----------
280301

@@ -285,6 +306,31 @@ see the |service| :oas-atlas-op:`Database Users API
285306
these descriptions, the available examples, and the |api| documentation
286307
to customize your specifications.
287308

309+
.. setting:: spec.awsIAMType
310+
311+
*Type*: string
312+
313+
*Optional*
314+
315+
Label that indicates whether the database user authenticates with the
316+
|aws| |iam| credentials associated with the user, or the user's role.
317+
If you don't specify a value, |service| uses the default value of ``NONE``.
318+
319+
This parameter accepts:
320+
321+
.. list-table::
322+
:stub-columns: 1
323+
:widths: 20 80
324+
325+
* - NONE
326+
- User who doesn't use |aws| |iam| authentication.
327+
328+
* - USER
329+
- User who authenticates with the |aws| |iam| credentials associated with the user.
330+
331+
* - ROLE
332+
- User who authenticates with the |aws| |iam| credentials associated with the user's role.
333+
288334
.. setting:: spec.databaseName
289335

290336
*Type*: string
@@ -384,6 +430,11 @@ to customize your specifications.
384430
</core/security-oidc>`, this value must be your |service| |oidc|
385431
|idp| followed by a forward slash ``/`` and your |idp| group name.
386432

433+
If the database user authenticates with |aws| |iam| credentials,
434+
this value must be the user that authenticates with the |aws| |iam|
435+
credentials or the role of the user that authenticates with the |aws|
436+
|iam| credentials in :aws-docs:`|arn| format <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html#arns-syntax>`__.
437+
387438
.. setting:: spec.x509Type
388439

389440
*Type*: string
@@ -435,3 +486,4 @@ Do not specify the following parameters:
435486
- ``password``
436487

437488
Specify :setting:`spec.passwordSecretRef` instead.
489+

0 commit comments

Comments
 (0)