File tree 4 files changed +5
-4
lines changed
src/aws_encryption_sdk/key_providers
test_vector_handlers/compatibility-requirements
4 files changed +5
-4
lines changed Original file line number Diff line number Diff line change @@ -128,7 +128,10 @@ pre-existing instance of a ``botocore session`` to the ``StrictAwsKmsMasterKeyPr
128
128
This latter option can be useful if you have an alternate way to store your AWS credentials or
129
129
you want to reuse an existing instance of a botocore session in order to decrease startup costs.
130
130
131
- To create a ``StrictAwsKmsMasterKeyProvider `` you must provide one or more CMKs.
131
+ To create a ``StrictAwsKmsMasterKeyProvider `` you must provide one or more CMKs. For providers that will only
132
+ be used for encryption, you can use any valid `KMS key identifier `_. For providers that will be used for decryption, you
133
+ must use the key ARN; key ids, alias names, and alias ARNs are not supported.
134
+
132
135
If you configure the the ``StrictAwsKmsMasterKeyProvider `` with multiple CMKs, the `final message `_
133
136
will include a copy of the data key encrypted by each configured CMK.
134
137
@@ -312,6 +315,7 @@ to your use-case in order to obtain peak performance.
312
315
.. _GitHub : https://github.com/aws/aws-encryption-sdk-python/
313
316
.. _AWS KMS : https://docs.aws.amazon.com/kms/latest/developerguide/overview.html
314
317
.. _KMS customer master key (CMK) : https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
318
+ .. _KMS key identifier : https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
315
319
.. _boto3 SDK : https://boto3.readthedocs.io/en/latest/
316
320
.. _standard means by which boto3 locates credentials : https://boto3.readthedocs.io/en/latest/guide/configuration.html
317
321
.. _final message : https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html
Original file line number Diff line number Diff line change @@ -283,7 +283,6 @@ class StrictAwsKmsMasterKeyProvider(BaseKMSMasterKeyProvider):
283
283
... 'arn:aws:kms:us-east-1:2222222222222:key/22222222-2222-2222-2222-222222222222',
284
284
... 'arn:aws:kms:us-east-1:3333333333333:key/33333333-3333-3333-3333-333333333333'
285
285
... ])
286
- >>> kms_key_provider.add_master_key('arn:aws:kms:ap-northeast-1:4444444444444:alias/another-key')
287
286
288
287
.. note::
289
288
If no botocore_session is provided, the default botocore session will be used.
Original file line number Diff line number Diff line change 1
1
aws-encryption-sdk==1.7.1
2
- attrs<19.2.0
Original file line number Diff line number Diff line change 1
1
aws-encryption-sdk==2.0.0
2
- attrs<19.2.0
You can’t perform that action at this time.
0 commit comments