@@ -275,6 +275,27 @@ specification with |oidc|.
275
275
username: my-oidc-group-id/my-idp-group-name
276
276
oidcAuthType: IDP_GROUP
277
277
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
+
278
299
Parameters
279
300
----------
280
301
@@ -285,6 +306,31 @@ see the |service| :oas-atlas-op:`Database Users API
285
306
these descriptions, the available examples, and the |api| documentation
286
307
to customize your specifications.
287
308
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
+
288
334
.. setting:: spec.databaseName
289
335
290
336
*Type*: string
@@ -384,6 +430,11 @@ to customize your specifications.
384
430
</core/security-oidc>`, this value must be your |service| |oidc|
385
431
|idp| followed by a forward slash ``/`` and your |idp| group name.
386
432
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
+
387
438
.. setting:: spec.x509Type
388
439
389
440
*Type*: string
@@ -435,3 +486,4 @@ Do not specify the following parameters:
435
486
- ``password``
436
487
437
488
Specify :setting:`spec.passwordSecretRef` instead.
489
+
0 commit comments