Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOCSP-43148 - Refactor AWS auth package #250

Closed
wants to merge 3 commits into from
Closed

DOCSP-43148 - Refactor AWS auth package #250

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d5e32b
add new aws steps
mongoKart Oct 10, 2024
cdc0d97
wording fix
mongoKart Oct 10, 2024
92b28b6
Update source/fundamentals/authentication.txt
mongoKart Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions source/fundamentals/authentication.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,23 @@ MONGODB-AWS
The ``MONGODB-AWS`` authentication mechanism is available only for
MongoDB deployments on MongoDB Atlas.

The ``MONGODB-AWS`` authentication mechanism uses your Amazon Web Services
Identity and Access Management (AWS IAM) credentials to authenticate your
user. You can either specify your credentials explicitly
or instruct the driver to retrieve them automatically from an external source.
The ``MONGODB-AWS`` authentication mechanism uses Amazon Web Services
Identity and Access Management (AWS IAM) credentials to authenticate a user to MongoDB.

The following sections contain code examples that use the following placeholders:
To use AWS authentication, first perform the following steps:

- Add the ``MongoDB.Driver.Authentication.AWS`` NuGet package to your project.
- Add the following line of code to your application's bootstrap code to register the
AWS authentication provider:

.. code-block:: csharp

MongoAuthentication.RegisterAwsAuthenticationProvider();

After you register the AWS authentication provider, you can either specify the AWS IAM
credentials explicitly or instruct the driver to retrieve them automatically from an
external source. The following sections describe both of these methods.
The code examples in these sections use the following placeholders:
mongoKart marked this conversation as resolved.
Show resolved Hide resolved

- ``<awsKeyId>`` - value of the AWS access key ID
- ``<awsSecretKey>`` - value of the AWS secret access key
Expand Down
5 changes: 5 additions & 0 deletions source/upgrade/v3.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,8 @@ Version 3.0 Breaking Changes

- The ``MongoClient`` constructor accepts only one ``Credential`` object instead of an
array.

- To use Amazon Web Services (AWS) authentication, you must add the
``MongoDB.Driver.Authentication.AWS`` package to your project and register the
authentication provider in your application's bootstrap code. To learn more about
using AWS authentication with the {+driver-short+}, see :ref:`csharp-mongodb-aws`.
Loading