Skip to content

Unclear configuration description :: KMSMasterKeyProvider #88

Closed
@mattsb42-aws

Description

@mattsb42-aws

In the readme description of how to configure AWS credentials for the KMSMasterKeyProvider[1], we state the following, linking to the boto3 configuration docs[2] (emphasis added).

To provide these credentials, use the standard means by which boto3 locates credentials or provide a pre-existing instance of a botocore session to the KMSMasterKeyProvider.

The intention of this portion of the documentation is to describe that if you do not provide an existing botocore session, one will be created for you using the default credential discovery procedure as described in the boto3 docs.

The current wording can be confusing because in addition to the automatic discovery procedure, the linked docs also describe how to manually provide credentials to a boto3 session or client.

We should update the wording to make the intended meaning clear.

[1] https://github.com/aws/aws-encryption-sdk-python/blob/master/README.rst#kmsmasterkeyprovider
[2] https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions