From 4d5e32b9357ab62d04d84e92aeaf92036e13c0bd Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:50:06 -0500 Subject: [PATCH 1/5] add new aws steps --- source/fundamentals/authentication.txt | 21 ++++++++++++++++----- source/upgrade/v3.txt | 5 +++++ 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index 6152db22..0e3750aa 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -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 a user's Amazon Web Services +Identity and Access Management (AWS IAM) credentials to authenticate them 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: - ```` - value of the AWS access key ID - ```` - value of the AWS secret access key diff --git a/source/upgrade/v3.txt b/source/upgrade/v3.txt index 7a88817a..1ffe1aca 100644 --- a/source/upgrade/v3.txt +++ b/source/upgrade/v3.txt @@ -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`. From cdc0d97f31fcc16f40b919977f1a71ab69e2a253 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:51:51 -0500 Subject: [PATCH 2/5] wording fix --- source/fundamentals/authentication.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index 0e3750aa..2ab2f410 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -153,8 +153,8 @@ MONGODB-AWS The ``MONGODB-AWS`` authentication mechanism is available only for MongoDB deployments on MongoDB Atlas. -The ``MONGODB-AWS`` authentication mechanism uses a user's Amazon Web Services -Identity and Access Management (AWS IAM) credentials to authenticate them to MongoDB. +The ``MONGODB-AWS`` authentication mechanism uses Amazon Web Services +Identity and Access Management (AWS IAM) credentials to authenticate a user to MongoDB. To use AWS authentication, first perform the following steps: From 92b28b6d8c8bf7038fc20f057ad190273aa2c561 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Fri, 11 Oct 2024 10:58:29 -0500 Subject: [PATCH 3/5] Update source/fundamentals/authentication.txt Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> --- source/fundamentals/authentication.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index 2ab2f410..77171179 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -168,7 +168,8 @@ To use AWS authentication, first perform the following steps: 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. +external source. The following sections describe both of these methods. + The code examples in these sections use the following placeholders: - ```` - value of the AWS access key ID From aebe079e90aafa2d219d74104d443c1c3dfd6567 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Wed, 16 Oct 2024 16:12:57 -0500 Subject: [PATCH 4/5] autobuilder From 323d056056182a8b62a3dce3dad5e75fe93609f2 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 17 Oct 2024 14:51:11 -0500 Subject: [PATCH 5/5] feedback --- source/fundamentals/authentication.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index 77171179..931a1e64 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -158,13 +158,15 @@ Identity and Access Management (AWS IAM) credentials to authenticate a user to M To use AWS authentication, first perform the following steps: -- Add the ``MongoDB.Driver.Authentication.AWS`` NuGet package to your project. +- 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 + :copyable: true - MongoAuthentication.RegisterAwsAuthenticationProvider(); + MongoClientSettings.Extensions.AddAWSAuthentication(); 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