-
Notifications
You must be signed in to change notification settings - Fork 24
DOCSP-43148 - Refactor AWS authentication #258
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.
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
Changes from 5 commits
4d5e32b
cdc0d97
92b28b6
aebe079
2c386d9
323d056
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -153,12 +153,24 @@ 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(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace the code with the following one: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's really weird. I don't know where that line came from. |
||
|
||
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: | ||
|
||
- ``<awsKeyId>`` - value of the AWS access key ID | ||
- ``<awsSecretKey>`` - value of the AWS secret access key | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we provide a link to nuget? https://www.nuget.org/packages/MongoDB.Driver.Authentication.AWS