Skip to content

Commit 3efeb41

Browse files
Any valid KMS key identifier can be used on encrypt
1 parent 138ec5b commit 3efeb41

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ This latter option can be useful if you have an alternate way to store your AWS
132132
you want to reuse an existing instance of a botocore session in order to decrease startup costs.
133133

134134
To create a ``StrictAwsKmsMasterKeyProvider`` you must provide one or more CMKs. For providers that will only
135-
be used for encryption, you can use a key ARN or alias ARN. For providers that will be used for decryption, you
136-
must use the key ARN; aliases are not supported.
135+
be used for encryption, you can use any valid `KMS key identifier`_. For providers that will be used for decryption, you
136+
must use the key ARN; key ids, alias names, and alias ARNs are not supported.
137137

138138
If you configure the the ``StrictAwsKmsMasterKeyProvider`` with multiple CMKs, the `final message`_
139139
will include a copy of the data key encrypted by each configured CMK.
@@ -318,6 +318,7 @@ to your use-case in order to obtain peak performance.
318318
.. _GitHub: https://github.com/aws/aws-encryption-sdk-python/
319319
.. _AWS KMS: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html
320320
.. _KMS customer master key (CMK): https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
321+
.. _KMS key identifier: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
321322
.. _boto3 SDK: https://boto3.readthedocs.io/en/latest/
322323
.. _standard means by which boto3 locates credentials: https://boto3.readthedocs.io/en/latest/guide/configuration.html
323324
.. _final message: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html

0 commit comments

Comments
 (0)