File tree Expand file tree Collapse file tree 2 files changed +21
-5
lines changed Expand file tree Collapse file tree 2 files changed +21
-5
lines changed Original file line number Diff line number Diff line change @@ -153,12 +153,23 @@ MONGODB-AWS
153153 The ``MONGODB-AWS`` authentication mechanism is available only for
154154 MongoDB deployments on MongoDB Atlas.
155155
156- The ``MONGODB-AWS`` authentication mechanism uses your Amazon Web Services
157- Identity and Access Management (AWS IAM) credentials to authenticate your
158- user. You can either specify your credentials explicitly
159- or instruct the driver to retrieve them automatically from an external source.
156+ The ``MONGODB-AWS`` authentication mechanism uses a user's Amazon Web Services
157+ Identity and Access Management (AWS IAM) credentials to authenticate them to MongoDB.
160158
161- The following sections contain code examples that use the following placeholders:
159+ To use AWS authentication, first perform the following steps:
160+
161+ - Add the ``MongoDB.Driver.Authentication.AWS`` NuGet package to your project.
162+ - Add the following line of code to your application's bootstrap code to register the
163+ AWS authentication provider:
164+
165+ .. code-block:: csharp
166+
167+ MongoAuthentication.RegisterAwsAuthenticationProvider();
168+
169+ After you register the AWS authentication provider, you can either specify the AWS IAM
170+ credentials explicitly or instruct the driver to retrieve them automatically from an
171+ external source. The following sections describe both of these methods.
172+ The code examples in these sections use the following placeholders:
162173
163174- ``<awsKeyId>`` - value of the AWS access key ID
164175- ``<awsSecretKey>`` - value of the AWS secret access key
Original file line number Diff line number Diff line change @@ -144,3 +144,8 @@ Version 3.0 Breaking Changes
144144
145145- The ``MongoClient`` constructor accepts only one ``Credential`` object instead of an
146146 array.
147+
148+ - To use Amazon Web Services (AWS) authentication, you must add the
149+ ``MongoDB.Driver.Authentication.AWS`` package to your project and register the
150+ authentication provider in your application's bootstrap code. To learn more about
151+ using AWS authentication with the {+driver-short+}, see :ref:`csharp-mongodb-aws`.
You can’t perform that action at this time.
0 commit comments