@@ -153,17 +153,17 @@ the ``authMechanism`` connection option.
153
153
154
154
.. note::
155
155
156
- The {+php-library+} uses the C driver 's implementation of the MONGODB-AWS
156
+ The {+php-library+} uses libmongoc 's implementation of the MONGODB-AWS
157
157
authentication mechanism. To learn more about using this authentication mechanism
158
- with the C driver , see `Authentication via AWS IAM
158
+ with libmongoc , see `Authentication via AWS IAM
159
159
<https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/authentication/#authentication-via-aws-iam>`__
160
- in the C documentation.
160
+ in the C driver documentation.
161
161
162
- When you use the MONGODB-AWS mechanism, the C driver tries to retrieve AWS
162
+ When you use the MONGODB-AWS mechanism, the driver tries to retrieve AWS
163
163
credentials from the following sources, in the order listed:
164
164
165
- 1. Options parameter passed to the ``MongoDB\Client`` constructor or parameters in the
166
- connection URI
165
+ 1. Options passed to the ``MongoDB\Client`` either as part of the connection
166
+ URI or an options parameter
167
167
#. Environment variables
168
168
#. AWS EKS ``AssumeRoleWithWebIdentity`` request
169
169
#. ECS container metadata
@@ -177,10 +177,10 @@ these sources and use them to authenticate your PHP application.
177
177
MongoDB\Client Credentials
178
178
~~~~~~~~~~~~~~~~~~~~~~~~~~
179
179
180
- First, the C driver checks whether you passed AWS credentials to the
181
- ``MongoDB\Client`` constructor, either as an options parameter or as part of the
182
- connection URI. To pass your credentials to ``MongoDB\Client``,
183
- set the following connection options:
180
+ First, the driver checks whether you passed AWS credentials to the
181
+ ``MongoDB\Client`` constructor, either as as part of the connection
182
+ URI or the ``$uriOptions`` array parameter . To pass your credentials to
183
+ ``MongoDB\Client``, set the following connection options:
184
184
185
185
- ``username``: The AWS IAM access key ID to authenticate. Percent-encode this value
186
186
before including it in a connection URI.
@@ -298,7 +298,7 @@ AssumeRoleWithWebIdentity Request
298
298
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299
299
300
300
If your application authenticates users for your EKS cluster from an OpenID Connect (OIDC)
301
- identity provider, the C driver can make an ``AssumeRoleWithWebIdentity`` request
301
+ identity provider, the driver can make an ``AssumeRoleWithWebIdentity`` request
302
302
to exchange the OIDC token for temporary AWS credentials for your application.
303
303
304
304
To authenticate with temporary AWS IAM credentials returned by an
@@ -328,7 +328,7 @@ ECS Metadata
328
328
~~~~~~~~~~~~
329
329
330
330
If your application runs in an Elastic Container Service (ECS) container,
331
- the C driver can automatically retrieve temporary AWS credentials from an
331
+ the driver can automatically retrieve temporary AWS credentials from an
332
332
ECS endpoint. To do so, specify the URI of the ECS endpoint in an environment variable called
333
333
``AWS_CONTAINER_CREDENTIALS_RELATIVE_URI``. You can set this variable by running
334
334
the ``export`` shell command or adding it to your ``.env`` file, as shown in the following
@@ -360,7 +360,7 @@ connection option to ``'MONGODB-AWS'``. To view an example that sets the
360
360
EC2 Instance Metadata
361
361
~~~~~~~~~~~~~~~~~~~~~
362
362
363
- The C driver can automatically retrieve temporary AWS credentials from an
363
+ The driver can automatically retrieve temporary AWS credentials from an
364
364
Amazon Elastic Cloud Compute (EC2) instance. To use temporary credentials from
365
365
within an EC2 instance, set the ``authMechanism`` connection option to ``'MONGODB-AWS'``.
366
366
To view an example that sets the ``authMechanism`` option, see the :ref:`authMechanism example
0 commit comments