DOCSP-26403: changes to aws credential retrieval (#691)

* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)

Author: rustagir

source/fundamentals/authentication/mechanisms.txt

@@ -235,6 +235,24 @@ The driver checks for your credentials in the following sources in order:
       .. literalinclude:: /code-snippets/authentication/aws-env-variable.js
          :language: javascript
 
+.. important:: Retrieval of AWS Credentials
+   
+   Starting in version 4.11, when you install the optional
+   ``aws-sdk/credential-providers`` dependency, the driver uses the AWS SDK
+   to retrieve credentials from the environment. As a result, if you
+   have a shared AWS credentials file or config file, the driver will
+   use those credentials by default.
+   
+   You can override this behavior by performing one of the following
+   actions:
+   
+   - Set ``AWS_SHARED_CREDENTIALS_FILE`` variable in your shell to point
+     to your credentials file.
+   - Set the equivalent environment variable in your application to point
+     to your credentials file.
+   - Create an AWS profile for your MongoDB credentials and set the
+     ``AWS_PROFILE`` environment variable to that profile name.
+
 ``X.509``
 ---------
 

source/whats-new.txt

@@ -106,7 +106,7 @@ New features of the 5.0 {+driver-short+} release include:
      This change is for Typescript only, and does not affect queries or operations
      at runtime.
 
-- Optional installation of ``@aws-sdk/credential-providers`` as a dependency.
+- Optional installation of ``@aws-sdk/credential-providers`` as a peer dependency.
 
   - The driver no longer includes AWS SDK modules by default. Use the
     following ``npm`` command to install the SDK:
@@ -202,19 +202,35 @@ To learn more, see the `v4.12.0 Release Highlights <https://github.com/mongodb/n
 What's New in 4.11
 ------------------
 
+Prioritization Order in Monitoring
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 When connecting to MongoDB Server version 6.0 or later, the driver prioritizes
 ``electionId`` settings before ``setVersion`` settings during Server Discovery and
 Monitoring events. In previous versions, the prioritization order was reversed.
 
-This release also includes added support for **mutually
+Changes to AWS Authentication
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When you install the optional ``aws-sdk/credential-providers``
+dependency, the driver uses the AWS SDK to retrieve AWS credentials from the
+environment.
+
+To learn more about this behavior, see the :ref:`MONGODB-AWS
+<mongodb-aws>` section of the Authentication Mechanisms guide.
+
+Mutually Recursive Schema Type Checking
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This release includes added support for **mutually
 recursive** collection schema types. The driver also provides type safety for
 dot-notation queries up to a depth of eight in this release. At a depth greater
 than or equal to eight, Typescript successfully compiles your code but does not
 provide type safety. This depth limit on recursive types is a current limitation
 of TypeScript.
 
-Mutually Recursive Schema Type Checking Example
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Example
+```````
 
 Suppose we have a collection of type ``Collection<Author>`` that contains the
 following mutually recursive types:
@@ -452,7 +468,7 @@ Key Changes
 ~~~~~~~~~~~
 
 Node.js Version
-+++++++++++++++
+```````````````
 
 The minimum supported version of Node.js is now v12.9 or greater for
 version 4 of the driver. Support for our 3.x branches will continue
@@ -464,7 +480,7 @@ until summer 2022 to allow time to upgrade.
 
 
 Cursor Improvements
-+++++++++++++++++++
+```````````````````
 
 Our Cursor implementation is now updated to make it clear what is possible
 before and after execution of an operation.
@@ -496,7 +512,7 @@ similar to the following:
   - ``ListCollectionsCursor``
 
 Cursor Stream API
-^^^^^^^^^^^^^^^^^
++++++++++++++++++
 
 Our Cursor types no longer extend ``Readable`` directly. They must be
 transformed into a stream by calling ``cursor.stream()``.
@@ -516,7 +532,7 @@ Use ``for await of`` syntax or any ``Promise`` helpers for
 asynchronous iteration.
 
 ``MongoClientOptions`` Interface
-+++++++++++++++++++++++++++++++++
+````````````````````````````````
 
 With type hinting, you should find that options passed to a ``MongoClient``
 are enumerated and discoverable. We've made a large effort to process
@@ -531,7 +547,7 @@ to get your app up and running in a correct state quickly.
 - It is no longer required to specify ``useUnifiedTopology`` or ``useNewUrlParser``.
 
 ``createCollection()``
-++++++++++++++++++++++
+``````````````````````
 
 This method no longer supports a ``strict`` option, which returned
 an error if the collection did not exist. To assert the existence of
@@ -550,7 +566,7 @@ a collection, use the ``listCollections()`` method instead.
       }
 
 ``BulkWriteError`` → ``MongoBulkWriteError``
-++++++++++++++++++++++++++++++++++++++++++++
+````````````````````````````````````````````
 
 ``BulkWriteError`` is now renamed to ``MongoBulkWriteError``.
 
@@ -559,20 +575,20 @@ depending on your settings. Import the new class name ``MongoBulkWriteError``
 when testing for errors in bulk operations.
 
 ``DB``
-++++++
+``````
 
 ``DB`` is no longer an ``EventEmitter``. Listen for events directly from your
 ``MongoClient`` instance.
 
 ``Collection.group()``
-++++++++++++++++++++++
+``````````````````````
 
 The ``Collection.group()`` helper, deprecated since MongoDB 3.4,
 is now removed. Use the aggregation pipeline :manual:`$group </reference/operator/aggregation/group/#pipe._S_group>`
 operator instead.
 
 Authentication
-++++++++++++++
+``````````````
 
 - ``gssapiServiceName`` is now removed. Use `authMechanismProperties.SERVICE_NAME <{+api+}/interfaces/MongoClientOptions.html#authMechanismProperties>`__ in the URI or as an option on ``MongoClientOptions``.
 
@@ -596,15 +612,15 @@ Authentication
         new MongoClient(url, { auth: { username: "<>", password: "<>" } })
 
 ``GridStore`` Removal
-+++++++++++++++++++++
+`````````````````````
 
 The GridStore API (already deprecated in 3.x) is now replaced with ``GridFSBucket``.
 For more information on ``GridFS``, see the :manual:`mongodb manual </core/gridfs>`.
 
 Below are some snippets that represent equivalent operations.
 
 Construction
-^^^^^^^^^^^^
+++++++++++++
 
 .. example::
 
@@ -616,7 +632,7 @@ Construction
       const bucket = new GridFSBucket(client.db('test')[,options])
 
 File Seeking
-^^^^^^^^^^^^
+++++++++++++
 
 GridFSBucket uses the Node.js Stream API. You can replicate file seeking
 by using the ``start`` and ``end`` options, creating a download stream
@@ -629,7 +645,7 @@ from your ``GridFSBucket``.
       bucket.openDownloadStreamByName(filename, { start: 0, end: 100 })
 
 File Upload & Download
-^^^^^^^^^^^^^^^^^^^^^^
+++++++++++++++++++++++
 
 .. example::
 
@@ -668,7 +684,7 @@ File Upload & Download
    ``GridFSBucket`` does not need to be closed like ``GridStore``.
 
 File Deletion
-^^^^^^^^^^^^^
++++++++++++++
 
 .. example::
 
@@ -680,7 +696,7 @@ File Deletion
       bucket.delete(file_id);
 
 Finding File Metadata
-^^^^^^^^^^^^^^^^^^^^^
++++++++++++++++++++++
 
 File metadata that used to be accessible on the ``GridStore`` instance can be
 found by querying the bucket.
@@ -692,7 +708,7 @@ found by querying the bucket.
       const fileMetaDataList: GridFSFile[] = bucket.find({}).toArray();
 
 Unified Topology
-++++++++++++++++
+````````````````
 
 - We internally now only manage a ``unifiedTopology`` when you connect
   to a ``mongod``. The differences between this and previous versions
@@ -704,13 +720,13 @@ Unified Topology
   to connect to uninitialized replica set members.
 
 Explain
-+++++++
+```````
 
 Support is now added for fine-grained verbosity modes. You can learn more
 about each mode :manual:`here </reference/method/cursor.explain/#behavior/>`.
 
 Command Monitoring
-++++++++++++++++++
+``````````````````
 
 The ``instrument()`` method is now removed. Use command monitoring instead.
 See our guide on :doc:`command monitoring </fundamentals/monitoring/command-monitoring>`