@aws-sdk/client-kms 3.28.0 → 3.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/KMS.ts +567 -572
- package/KMSClient.ts +18 -18
- package/README.md +18 -18
- package/commands/CancelKeyDeletionCommand.ts +6 -7
- package/commands/ConnectCustomKeyStoreCommand.ts +9 -9
- package/commands/CreateAliasCommand.ts +13 -14
- package/commands/CreateCustomKeyStoreCommand.ts +8 -8
- package/commands/CreateGrantCommand.ts +15 -22
- package/commands/CreateKeyCommand.ts +44 -44
- package/commands/DecryptCommand.ts +23 -22
- package/commands/DeleteAliasCommand.ts +7 -8
- package/commands/DeleteCustomKeyStoreCommand.ts +13 -13
- package/commands/DeleteImportedKeyMaterialCommand.ts +9 -9
- package/commands/DescribeCustomKeyStoresCommand.ts +6 -6
- package/commands/DescribeKeyCommand.ts +18 -19
- package/commands/DisableKeyCommand.ts +7 -7
- package/commands/DisableKeyRotationCommand.ts +5 -6
- package/commands/DisconnectCustomKeyStoreCommand.ts +6 -8
- package/commands/EnableKeyCommand.ts +4 -5
- package/commands/EnableKeyRotationCommand.ts +5 -5
- package/commands/EncryptCommand.ts +20 -21
- package/commands/GenerateDataKeyCommand.ts +17 -18
- package/commands/GenerateDataKeyPairCommand.ts +21 -15
- package/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts +16 -12
- package/commands/GenerateDataKeyWithoutPlaintextCommand.ts +9 -9
- package/commands/GenerateRandomCommand.ts +4 -3
- package/commands/GetKeyPolicyCommand.ts +2 -2
- package/commands/GetKeyRotationStatusCommand.ts +9 -9
- package/commands/GetParametersForImportCommand.ts +8 -8
- package/commands/GetPublicKeyCommand.ts +15 -15
- package/commands/ImportKeyMaterialCommand.ts +18 -18
- package/commands/ListAliasesCommand.ts +8 -10
- package/commands/ListGrantsCommand.ts +9 -4
- package/commands/ListKeyPoliciesCommand.ts +2 -2
- package/commands/ListKeysCommand.ts +2 -2
- package/commands/ListResourceTagsCommand.ts +4 -4
- package/commands/ListRetirableGrantsCommand.ts +14 -14
- package/commands/PutKeyPolicyCommand.ts +5 -5
- package/commands/ReEncryptCommand.ts +30 -34
- package/commands/ReplicateKeyCommand.ts +16 -16
- package/commands/RetireGrantCommand.ts +9 -9
- package/commands/RevokeGrantCommand.ts +9 -4
- package/commands/ScheduleKeyDeletionCommand.ts +17 -17
- package/commands/SignCommand.ts +12 -13
- package/commands/TagResourceCommand.ts +10 -12
- package/commands/UntagResourceCommand.ts +9 -10
- package/commands/UpdateAliasCommand.ts +15 -15
- package/commands/UpdateCustomKeyStoreCommand.ts +9 -9
- package/commands/UpdateKeyDescriptionCommand.ts +4 -4
- package/commands/UpdatePrimaryRegionCommand.ts +13 -13
- package/commands/VerifyCommand.ts +14 -14
- package/dist/cjs/KMS.js +18 -18
- package/dist/cjs/KMS.js.map +1 -1
- package/dist/cjs/KMSClient.js +18 -18
- package/dist/cjs/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/cjs/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/cjs/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/CreateAliasCommand.js +13 -14
- package/dist/cjs/commands/CreateAliasCommand.js.map +1 -1
- package/dist/cjs/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/cjs/commands/CreateGrantCommand.js +15 -22
- package/dist/cjs/commands/CreateGrantCommand.js.map +1 -1
- package/dist/cjs/commands/CreateKeyCommand.js +44 -44
- package/dist/cjs/commands/DecryptCommand.js +23 -22
- package/dist/cjs/commands/DecryptCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteAliasCommand.js +7 -8
- package/dist/cjs/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/cjs/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/cjs/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/cjs/commands/DescribeKeyCommand.js +18 -19
- package/dist/cjs/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/cjs/commands/DisableKeyCommand.js +7 -7
- package/dist/cjs/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/cjs/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyCommand.js +4 -5
- package/dist/cjs/commands/EnableKeyCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/cjs/commands/EncryptCommand.js +20 -21
- package/dist/cjs/commands/EncryptCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/cjs/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/cjs/commands/GenerateRandomCommand.js +4 -3
- package/dist/cjs/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/cjs/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/cjs/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/cjs/commands/GetParametersForImportCommand.js +8 -8
- package/dist/cjs/commands/GetPublicKeyCommand.js +15 -15
- package/dist/cjs/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/cjs/commands/ListAliasesCommand.js +8 -10
- package/dist/cjs/commands/ListAliasesCommand.js.map +1 -1
- package/dist/cjs/commands/ListGrantsCommand.js +9 -4
- package/dist/cjs/commands/ListGrantsCommand.js.map +1 -1
- package/dist/cjs/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/cjs/commands/ListKeysCommand.js +2 -2
- package/dist/cjs/commands/ListResourceTagsCommand.js +4 -4
- package/dist/cjs/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/cjs/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/cjs/commands/ReEncryptCommand.js +30 -34
- package/dist/cjs/commands/ReEncryptCommand.js.map +1 -1
- package/dist/cjs/commands/ReplicateKeyCommand.js +16 -16
- package/dist/cjs/commands/RetireGrantCommand.js +9 -9
- package/dist/cjs/commands/RevokeGrantCommand.js +9 -4
- package/dist/cjs/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/cjs/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/cjs/commands/SignCommand.js +12 -13
- package/dist/cjs/commands/SignCommand.js.map +1 -1
- package/dist/cjs/commands/TagResourceCommand.js +10 -12
- package/dist/cjs/commands/TagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UntagResourceCommand.js +9 -10
- package/dist/cjs/commands/UntagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UpdateAliasCommand.js +15 -15
- package/dist/cjs/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/cjs/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/cjs/commands/VerifyCommand.js +14 -14
- package/dist/cjs/models/models_0.js +14 -3
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_json1_1.js +16 -11
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/KMS.js +18 -18
- package/dist/es/KMS.js.map +1 -1
- package/dist/es/KMSClient.js +18 -18
- package/dist/es/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/es/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/es/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/CreateAliasCommand.js +13 -14
- package/dist/es/commands/CreateAliasCommand.js.map +1 -1
- package/dist/es/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/es/commands/CreateGrantCommand.js +15 -22
- package/dist/es/commands/CreateGrantCommand.js.map +1 -1
- package/dist/es/commands/CreateKeyCommand.js +44 -44
- package/dist/es/commands/DecryptCommand.js +23 -22
- package/dist/es/commands/DecryptCommand.js.map +1 -1
- package/dist/es/commands/DeleteAliasCommand.js +7 -8
- package/dist/es/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/es/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/es/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/es/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/es/commands/DescribeKeyCommand.js +18 -19
- package/dist/es/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/es/commands/DisableKeyCommand.js +7 -7
- package/dist/es/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/es/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyCommand.js +4 -5
- package/dist/es/commands/EnableKeyCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/es/commands/EncryptCommand.js +20 -21
- package/dist/es/commands/EncryptCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/es/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/es/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/es/commands/GenerateRandomCommand.js +4 -3
- package/dist/es/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/es/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/es/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/es/commands/GetParametersForImportCommand.js +8 -8
- package/dist/es/commands/GetPublicKeyCommand.js +15 -15
- package/dist/es/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/es/commands/ListAliasesCommand.js +8 -10
- package/dist/es/commands/ListAliasesCommand.js.map +1 -1
- package/dist/es/commands/ListGrantsCommand.js +9 -4
- package/dist/es/commands/ListGrantsCommand.js.map +1 -1
- package/dist/es/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/es/commands/ListKeysCommand.js +2 -2
- package/dist/es/commands/ListResourceTagsCommand.js +4 -4
- package/dist/es/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/es/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/es/commands/ReEncryptCommand.js +30 -34
- package/dist/es/commands/ReEncryptCommand.js.map +1 -1
- package/dist/es/commands/ReplicateKeyCommand.js +16 -16
- package/dist/es/commands/RetireGrantCommand.js +9 -9
- package/dist/es/commands/RevokeGrantCommand.js +9 -4
- package/dist/es/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/es/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/es/commands/SignCommand.js +12 -13
- package/dist/es/commands/SignCommand.js.map +1 -1
- package/dist/es/commands/TagResourceCommand.js +10 -12
- package/dist/es/commands/TagResourceCommand.js.map +1 -1
- package/dist/es/commands/UntagResourceCommand.js +9 -10
- package/dist/es/commands/UntagResourceCommand.js.map +1 -1
- package/dist/es/commands/UpdateAliasCommand.js +15 -15
- package/dist/es/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/es/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/es/commands/VerifyCommand.js +14 -14
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +11 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_json1_1.js +18 -14
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/KMS.d.ts +567 -572
- package/dist/types/KMSClient.d.ts +18 -18
- package/dist/types/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/commands/SignCommand.d.ts +12 -13
- package/dist/types/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/models/models_0.d.ts +584 -570
- package/dist/types/ts3.4/KMS.d.ts +567 -572
- package/dist/types/ts3.4/KMSClient.d.ts +18 -18
- package/dist/types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/ts3.4/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/ts3.4/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/ts3.4/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/ts3.4/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/ts3.4/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/ts3.4/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/ts3.4/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/ts3.4/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/ts3.4/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/ts3.4/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/ts3.4/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/ts3.4/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/ts3.4/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/ts3.4/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/ts3.4/commands/SignCommand.d.ts +12 -13
- package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/ts3.4/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/ts3.4/models/models_0.d.ts +584 -570
- package/models/models_0.ts +588 -570
- package/package.json +31 -31
- package/protocols/Aws_json1_1.ts +20 -12
|
@@ -6,26 +6,25 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Creates a friendly name for a
|
|
9
|
+
* <p>Creates a friendly name for a KMS key. </p>
|
|
10
10
|
* <note>
|
|
11
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
11
|
+
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
* <p>You can use an alias to identify a
|
|
14
|
-
* <a>GenerateDataKey</a>. You can also change the
|
|
13
|
+
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and
|
|
14
|
+
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with the
|
|
15
15
|
* alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>) at
|
|
16
|
-
* any time. These operations don't affect the underlying
|
|
17
|
-
* <p>You can associate the alias with any customer managed
|
|
18
|
-
* alias is associated with only one
|
|
19
|
-
* CMK is required. You can't create an alias without a CMK.</p>
|
|
16
|
+
* any time. These operations don't affect the underlying KMS key. </p>
|
|
17
|
+
* <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
|
|
18
|
+
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.</p>
|
|
20
19
|
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
21
20
|
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">Using aliases</a> in the
|
|
22
|
-
* <i>
|
|
21
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
23
22
|
* <p>This operation does not return a response. To get the alias that you created, use the
|
|
24
23
|
* <a>ListAliases</a> operation.</p>
|
|
25
|
-
* <p>The
|
|
26
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
24
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
25
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
27
26
|
* <p>
|
|
28
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
27
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
29
28
|
*
|
|
30
29
|
* <p>
|
|
31
30
|
* <b>Required permissions</b>
|
|
@@ -37,10 +36,10 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
|
37
36
|
* </li>
|
|
38
37
|
* <li>
|
|
39
38
|
* <p>
|
|
40
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on the
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on the KMS key (key policy).</p>
|
|
41
40
|
* </li>
|
|
42
41
|
* </ul>
|
|
43
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
42
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
44
43
|
* <p>
|
|
45
44
|
* <b>Related operations:</b>
|
|
46
45
|
* </p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateAliasCommand.js","sourceRoot":"","sources":["../../../commands/CreateAliasCommand.ts"],"names":[],"mappings":";;;AACA,iDAAwD;AACxD,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D
|
|
1
|
+
{"version":3,"file":"CreateAliasCommand.js","sourceRoot":"","sources":["../../../commands/CreateAliasCommand.ts"],"names":[],"mappings":";;;AACA,iDAAwD;AACxD,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,MAAa,kBAAmB,SAAQ,uBAIvC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,YAAqB,KAA8B;QACjD,qCAAqC;QACrC,KAAK,EAAE,CAAC;QAFW,UAAK,GAAL,KAAK,CAAyB;QAGjD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,iCAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACjC,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,MAAM,WAAW,GAAG,oBAAoB,CAAC;QACzC,MAAM,uBAAuB,GAA4B;YACvD,MAAM;YACN,UAAU;YACV,WAAW;YACX,uBAAuB,EAAE,6BAAkB,CAAC,kBAAkB;YAC9D,wBAAwB,EAAE,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM;SAClD,CAAC;QACF,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,CAAC,OAAsC,EAAE,EAAE,CACzC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,KAA8B,EAAE,OAAuB;QACvE,OAAO,oDAAsC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,WAAW,CAAC,MAAsB,EAAE,OAAuB;QACjE,OAAO,sDAAwC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CAIF;AAtDD,gDAsDC"}
|
|
@@ -6,24 +6,24 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">
|
|
9
|
+
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">CloudHSM cluster</a> that you own and
|
|
10
10
|
* manage.</p>
|
|
11
|
-
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in
|
|
12
|
-
* combines the convenience and extensive integration of
|
|
11
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
12
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
13
13
|
* single-tenant key store.</p>
|
|
14
14
|
* <p>Before you create the custom key store, you must assemble
|
|
15
|
-
* the required elements, including an
|
|
15
|
+
* the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
|
|
16
16
|
* key store. For details about the required elements, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
|
|
17
|
-
* in the <i>
|
|
17
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
18
18
|
* <p>When the operation completes successfully, it returns the ID of the new custom key store.
|
|
19
|
-
* Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its
|
|
19
|
+
* Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its CloudHSM
|
|
20
20
|
* cluster. Even if you are not going to use your custom key store immediately, you might want to
|
|
21
21
|
* connect it to verify that all settings are correct and then disconnect it until you are ready
|
|
22
22
|
* to use it.</p>
|
|
23
23
|
* <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the
|
|
24
|
-
* <i>
|
|
24
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
25
25
|
* <p>
|
|
26
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
26
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
27
27
|
* <p>
|
|
28
28
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateCustomKeyStore</a> (IAM policy).</p>
|
|
29
29
|
* <p>
|
|
@@ -6,45 +6,38 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Adds a grant to a
|
|
10
|
-
* <p>A <i>grant</i> is a policy instrument that allows
|
|
11
|
-
* KMS customer master keys (CMKs) in cryptographic operations. It also can allow them to view a
|
|
12
|
-
* CMK (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a
|
|
13
|
-
* CMK, grants are considered along with key policies and IAM policies. Grants are often used for
|
|
9
|
+
* <p>Adds a grant to a KMS key. </p>
|
|
10
|
+
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for
|
|
14
11
|
* temporary permissions because you can create one, use its permissions, and delete it without
|
|
15
12
|
* changing your key policies or IAM policies. </p>
|
|
16
13
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
17
14
|
* <i>
|
|
18
|
-
* <i>
|
|
15
|
+
* <i>Key Management Service Developer Guide</i>
|
|
19
16
|
* </i>. For examples of working with grants in several
|
|
20
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
17
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
21
18
|
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
22
|
-
*
|
|
19
|
+
* <code>GrantId</code>.</p>
|
|
23
20
|
* <ul>
|
|
24
21
|
* <li>
|
|
25
|
-
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout
|
|
26
|
-
*
|
|
22
|
+
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee principal
|
|
23
|
+
* can use the permissions in the grant without identifying the grant. </p>
|
|
27
24
|
* <p>However, to use the permissions in the grant immediately, use the
|
|
28
|
-
*
|
|
25
|
+
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant
|
|
29
26
|
* token</a> in the <i>
|
|
30
|
-
* <i>
|
|
27
|
+
* <i>Key Management Service Developer Guide</i>
|
|
31
28
|
* </i>.</p>
|
|
32
29
|
* </li>
|
|
33
30
|
* <li>
|
|
34
31
|
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can use the
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
32
|
+
* <code>GrantId</code> and a key identifier to identify the grant in the <a>RetireGrant</a> and <a>RevokeGrant</a> operations. To find the grant
|
|
33
|
+
* ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
|
|
34
|
+
* operations.</p>
|
|
38
35
|
* </li>
|
|
39
36
|
* </ul>
|
|
40
|
-
* <p>
|
|
41
|
-
*
|
|
42
|
-
* <i>AWS Key Management Service Developer Guide</i>
|
|
43
|
-
* </i>.</p>
|
|
44
|
-
* <p>The CMK that you use for this operation must be in a compatible key state. For
|
|
45
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
37
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
38
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
46
39
|
* <p>
|
|
47
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
40
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
48
41
|
* ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
49
42
|
* <p>
|
|
50
43
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateGrant</a> (key policy)</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateGrantCommand.js","sourceRoot":"","sources":["../../../commands/CreateGrantCommand.ts"],"names":[],"mappings":";;;AACA,iDAA6E;AAC7E,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D
|
|
1
|
+
{"version":3,"file":"CreateGrantCommand.js","sourceRoot":"","sources":["../../../commands/CreateGrantCommand.ts"],"names":[],"mappings":";;;AACA,iDAA6E;AAC7E,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAa,kBAAmB,SAAQ,uBAIvC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,YAAqB,KAA8B;QACjD,qCAAqC;QACrC,KAAK,EAAE,CAAC;QAFW,UAAK,GAAL,KAAK,CAAyB;QAGjD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,iCAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACjC,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,MAAM,WAAW,GAAG,oBAAoB,CAAC;QACzC,MAAM,uBAAuB,GAA4B;YACvD,MAAM;YACN,UAAU;YACV,WAAW;YACX,uBAAuB,EAAE,6BAAkB,CAAC,kBAAkB;YAC9D,wBAAwB,EAAE,8BAAmB,CAAC,kBAAkB;SACjE,CAAC;QACF,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,CAAC,OAAsC,EAAE,EAAE,CACzC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,KAA8B,EAAE,OAAuB;QACvE,OAAO,oDAAsC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,WAAW,CAAC,MAAsB,EAAE,OAAuB;QACjE,OAAO,sDAAwC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CAIF;AAtDD,gDAsDC"}
|
|
@@ -6,109 +6,109 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#
|
|
10
|
-
*
|
|
9
|
+
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and Region.</p>
|
|
10
|
+
* <note>
|
|
11
|
+
* <p>KMS is replacing the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
12
|
+
* </note>
|
|
11
13
|
*
|
|
12
|
-
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric
|
|
13
|
-
* CMKs.</p>
|
|
14
|
+
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS keys.</p>
|
|
14
15
|
* <ul>
|
|
15
16
|
* <li>
|
|
16
17
|
* <p>
|
|
17
|
-
* <b>Symmetric
|
|
18
|
-
* never leaves
|
|
19
|
-
* symmetric
|
|
18
|
+
* <b>Symmetric KMS keys</b> contain a 256-bit symmetric key that
|
|
19
|
+
* never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use a
|
|
20
|
+
* symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically used to
|
|
20
21
|
* generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|
21
22
|
* keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
|
|
22
23
|
* see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
|
|
23
24
|
* </li>
|
|
24
25
|
* <li>
|
|
25
26
|
* <p>
|
|
26
|
-
* <b>Asymmetric
|
|
27
|
-
* Elliptic Curve (ECC) key pair. The private key in an asymmetric
|
|
27
|
+
* <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
|
|
28
|
+
* Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
|
|
28
29
|
* unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
|
|
29
|
-
* the public key so it can be used outside of
|
|
30
|
-
* encrypt or decrypt data or sign and verify messages (but not both).
|
|
30
|
+
* the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used to
|
|
31
|
+
* encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key
|
|
31
32
|
* pairs can be used only to sign and verify messages.</p>
|
|
32
33
|
* </li>
|
|
33
34
|
* </ul>
|
|
34
|
-
* <p>For information about symmetric and asymmetric
|
|
35
|
+
* <p>For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
35
36
|
*
|
|
36
37
|
*
|
|
37
|
-
* <p>To create different types of
|
|
38
|
+
* <p>To create different types of KMS keys, use the following guidance:</p>
|
|
38
39
|
*
|
|
39
40
|
* <dl>
|
|
40
|
-
* <dt>Asymmetric
|
|
41
|
+
* <dt>Asymmetric KMS keys</dt>
|
|
41
42
|
* <dd>
|
|
42
|
-
* <p>To create an asymmetric
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
43
|
+
* <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify
|
|
44
|
+
* the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter
|
|
45
|
+
* to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.
|
|
46
|
+
* You can't change these properties after the KMS key is created.</p>
|
|
46
47
|
* <p> </p>
|
|
47
48
|
* </dd>
|
|
48
|
-
* <dt>Symmetric
|
|
49
|
+
* <dt>Symmetric KMS keys</dt>
|
|
49
50
|
* <dd>
|
|
50
|
-
* <p>When creating a symmetric
|
|
51
|
-
* <code>
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
51
|
+
* <p>When creating a symmetric KMS key, you don't need to specify the
|
|
52
|
+
* <code>KeySpec</code> or <code>KeyUsage</code> parameters. The default value for
|
|
53
|
+
* <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for
|
|
54
|
+
* <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for
|
|
55
|
+
* symmetric KMS keys. </p>
|
|
55
56
|
* <p> </p>
|
|
56
57
|
* </dd>
|
|
57
58
|
* <dt>Multi-Region primary keys</dt>
|
|
58
59
|
* <dt>Imported key material</dt>
|
|
59
60
|
* <dd>
|
|
60
|
-
* <p>To create a multi-Region <i>primary key</i> in the local
|
|
61
|
+
* <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
|
|
61
62
|
* use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
|
|
62
|
-
* a multi-Region <i>replica key</i>, that is, a
|
|
63
|
-
* key material as a primary key, but in a different
|
|
63
|
+
* a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID and
|
|
64
|
+
* key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its
|
|
64
65
|
* primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
|
|
65
66
|
* operation.</p>
|
|
66
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
67
|
-
* interoperable
|
|
68
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
69
|
-
* it in a different
|
|
67
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
68
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
69
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
70
|
+
* it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
70
71
|
* <p>You can create symmetric and asymmetric multi-Region keys and multi-Region keys with
|
|
71
72
|
* imported key material. You cannot create multi-Region keys in a custom key store.</p>
|
|
72
73
|
* <p> </p>
|
|
73
74
|
* </dd>
|
|
74
75
|
* <dd>
|
|
75
|
-
* <p>To import your own key material, begin by creating a symmetric
|
|
76
|
+
* <p>To import your own key material, begin by creating a symmetric KMS key with no key
|
|
76
77
|
* material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code>
|
|
77
78
|
* with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt
|
|
78
79
|
* your key material. Then, use <a>ImportKeyMaterial</a> with your import token
|
|
79
80
|
* to import the key material. For step-by-step instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>
|
|
80
|
-
* <i>
|
|
81
|
+
* <i>Key Management Service Developer Guide</i>
|
|
81
82
|
* </i>. You
|
|
82
|
-
* cannot import the key material into an asymmetric
|
|
83
|
+
* cannot import the key material into an asymmetric KMS key.</p>
|
|
83
84
|
* <p>To create a multi-Region primary key with imported key material, use the
|
|
84
85
|
* <code>Origin</code> parameter of <code>CreateKey</code> with a value of
|
|
85
86
|
* <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
|
|
86
|
-
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>
|
|
87
|
+
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
87
88
|
* <p> </p>
|
|
88
89
|
* </dd>
|
|
89
90
|
* <dt>Custom key store</dt>
|
|
90
91
|
* <dd>
|
|
91
|
-
* <p>To create a symmetric
|
|
92
|
+
* <p>To create a symmetric KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, use the
|
|
92
93
|
* <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also
|
|
93
94
|
* use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
|
|
94
|
-
*
|
|
95
|
-
* HSMs in different Availability Zones in the
|
|
96
|
-
* <p>You cannot create an asymmetric
|
|
97
|
-
*
|
|
95
|
+
* CloudHSM cluster that is associated with the custom key store must have at least two active
|
|
96
|
+
* HSMs in different Availability Zones in the Amazon Web Services Region. </p>
|
|
97
|
+
* <p>You cannot create an asymmetric KMS key in a custom key store. For information about
|
|
98
|
+
* custom key stores in KMS see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Using Custom Key Stores</a> in
|
|
98
99
|
* the <i>
|
|
99
|
-
* <i>
|
|
100
|
+
* <i>Key Management Service Developer Guide</i>
|
|
100
101
|
* </i>.</p>
|
|
101
102
|
* </dd>
|
|
102
103
|
* </dl>
|
|
103
104
|
* <p>
|
|
104
105
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
105
|
-
* create a
|
|
106
|
+
* create a KMS key in a different Amazon Web Services account.</p>
|
|
106
107
|
*
|
|
107
108
|
* <p>
|
|
108
109
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
|
|
109
110
|
* <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
|
|
110
|
-
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create
|
|
111
|
-
* CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
111
|
+
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
112
112
|
* <p>
|
|
113
113
|
* <b>Related operations:</b>
|
|
114
114
|
* </p>
|
|
@@ -6,7 +6,7 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Decrypts ciphertext that was encrypted by a
|
|
9
|
+
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of
|
|
10
10
|
* the following operations:</p>
|
|
11
11
|
* <ul>
|
|
12
12
|
* <li>
|
|
@@ -36,33 +36,34 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
38
|
* <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
|
|
39
|
-
* asymmetric
|
|
40
|
-
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric
|
|
41
|
-
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of
|
|
42
|
-
* public key in an
|
|
43
|
-
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">
|
|
39
|
+
* asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption
|
|
40
|
+
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
41
|
+
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
|
|
42
|
+
* public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other
|
|
43
|
+
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption
|
|
44
44
|
* SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that
|
|
45
|
-
* is incompatible with
|
|
46
|
-
* <p>If the ciphertext was encrypted under a symmetric
|
|
47
|
-
* optional.
|
|
45
|
+
* is incompatible with KMS.</p>
|
|
46
|
+
* <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code> parameter is
|
|
47
|
+
* optional. KMS can get this information from metadata that it adds to the symmetric
|
|
48
48
|
* ciphertext blob. This feature adds durability to your implementation by ensuring that
|
|
49
49
|
* authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost
|
|
50
|
-
* track of the
|
|
51
|
-
* When you use the <code>KeyId</code> parameter to specify a
|
|
52
|
-
* specify. If the ciphertext was encrypted under a different
|
|
53
|
-
* operation fails. This practice ensures that you use the
|
|
50
|
+
* track of the key ID. However, specifying the KMS key is always recommended as a best practice.
|
|
51
|
+
* When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses the KMS key you
|
|
52
|
+
* specify. If the ciphertext was encrypted under a different KMS key, the <code>Decrypt</code>
|
|
53
|
+
* operation fails. This practice ensures that you use the KMS key that you intend.</p>
|
|
54
54
|
* <p>Whenever possible, use key policies to give users permission to call the
|
|
55
|
-
* <code>Decrypt</code> operation on a particular
|
|
55
|
+
* <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
|
|
56
56
|
* Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
|
|
57
|
-
* permission on all
|
|
58
|
-
* accounts if the key policy for the cross-account
|
|
59
|
-
* for <code>Decrypt</code> permissions, limit the user to particular
|
|
60
|
-
* accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM policies</a> in the <i>
|
|
61
|
-
* <p>
|
|
62
|
-
*
|
|
57
|
+
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other
|
|
58
|
+
* accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy
|
|
59
|
+
* for <code>Decrypt</code> permissions, limit the user to particular KMS keys or particular trusted
|
|
60
|
+
* accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
61
|
+
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
62
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
63
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
63
64
|
* <p>
|
|
64
|
-
* <b>Cross-account use</b>: Yes.
|
|
65
|
-
*
|
|
65
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
66
|
+
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
66
67
|
*
|
|
67
68
|
* <p>
|
|
68
69
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Decrypt</a> (key policy)</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DecryptCommand.js","sourceRoot":"","sources":["../../../commands/DecryptCommand.ts"],"names":[],"mappings":";;;AACA,iDAAqE;AACrE,0DAAoH;AACpH,gEAA2D;AAE3D,0DAA6D;AAc7D
|
|
1
|
+
{"version":3,"file":"DecryptCommand.js","sourceRoot":"","sources":["../../../commands/DecryptCommand.ts"],"names":[],"mappings":";;;AACA,iDAAqE;AACrE,0DAAoH;AACpH,gEAA2D;AAE3D,0DAA6D;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqGG;AACH,MAAa,cAAe,SAAQ,uBAA4E;IAC9G,oCAAoC;IACpC,kCAAkC;IAElC,YAAqB,KAA0B;QAC7C,qCAAqC;QACrC,KAAK,EAAE,CAAC;QAFW,UAAK,GAAL,KAAK,CAAqB;QAG7C,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,iCAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACjC,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,MAAM,WAAW,GAAG,gBAAgB,CAAC;QACrC,MAAM,uBAAuB,GAA4B;YACvD,MAAM;YACN,UAAU;YACV,WAAW;YACX,uBAAuB,EAAE,yBAAc,CAAC,kBAAkB;YAC1D,wBAAwB,EAAE,0BAAe,CAAC,kBAAkB;SAC7D,CAAC;QACF,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,CAAC,OAAsC,EAAE,EAAE,CACzC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,KAA0B,EAAE,OAAuB;QACnE,OAAO,gDAAkC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEO,WAAW,CAAC,MAAsB,EAAE,OAAuB;QACjE,OAAO,kDAAoC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CAIF;AAlDD,wCAkDC"}
|
|
@@ -8,15 +8,14 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
|
8
8
|
/**
|
|
9
9
|
* <p>Deletes the specified alias. </p>
|
|
10
10
|
* <note>
|
|
11
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
11
|
+
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
* <p>Because an alias is not a property of a
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* create a new alias. To associate an existing alias with a different customer master key (CMK),
|
|
13
|
+
* <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
|
|
14
|
+
* <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to
|
|
15
|
+
* create a new alias. To associate an existing alias with a different KMS key,
|
|
17
16
|
* call <a>UpdateAlias</a>.</p>
|
|
18
17
|
* <p>
|
|
19
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
18
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
20
19
|
* <p>
|
|
21
20
|
* <b>Required permissions</b>
|
|
22
21
|
* </p>
|
|
@@ -27,10 +26,10 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
|
27
26
|
* </li>
|
|
28
27
|
* <li>
|
|
29
28
|
* <p>
|
|
30
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the
|
|
29
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the KMS key (key policy).</p>
|
|
31
30
|
* </li>
|
|
32
31
|
* </ul>
|
|
33
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
32
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
34
33
|
* <p>
|
|
35
34
|
* <b>Related operations:</b>
|
|
36
35
|
* </p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DeleteAliasCommand.js","sourceRoot":"","sources":["../../../commands/DeleteAliasCommand.ts"],"names":[],"mappings":";;;AACA,iDAAwD;AACxD,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D
|
|
1
|
+
{"version":3,"file":"DeleteAliasCommand.js","sourceRoot":"","sources":["../../../commands/DeleteAliasCommand.ts"],"names":[],"mappings":";;;AACA,iDAAwD;AACxD,0DAGkC;AAClC,gEAA2D;AAE3D,0DAA6D;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAa,kBAAmB,SAAQ,uBAIvC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,YAAqB,KAA8B;QACjD,qCAAqC;QACrC,KAAK,EAAE,CAAC;QAFW,UAAK,GAAL,KAAK,CAAyB;QAGjD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,iCAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACjC,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,MAAM,WAAW,GAAG,oBAAoB,CAAC;QACzC,MAAM,uBAAuB,GAA4B;YACvD,MAAM;YACN,UAAU;YACV,WAAW;YACX,uBAAuB,EAAE,6BAAkB,CAAC,kBAAkB;YAC9D,wBAAwB,EAAE,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM;SAClD,CAAC;QACF,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,CAAC,OAAsC,EAAE,EAAE,CACzC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,KAA8B,EAAE,OAAuB;QACvE,OAAO,oDAAsC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,WAAW,CAAC,MAAsB,EAAE,OAAuB;QACjE,OAAO,sDAAwC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CAIF;AAtDD,gDAsDC"}
|
|
@@ -6,29 +6,29 @@ const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
|
|
|
6
6
|
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
|
-
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the
|
|
9
|
+
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the CloudHSM cluster that is
|
|
10
10
|
* associated with the custom key store, or affect any users or keys in the cluster.</p>
|
|
11
|
-
* <p>The custom key store that you delete cannot contain any
|
|
12
|
-
* deleting the key store, verify that you will never need to use any of the
|
|
11
|
+
* <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before
|
|
12
|
+
* deleting the key store, verify that you will never need to use any of the KMS keys in the key
|
|
13
13
|
* store for any <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the
|
|
14
|
-
*
|
|
15
|
-
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the
|
|
14
|
+
* KMS keys from the key store. When the scheduled waiting period
|
|
15
|
+
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the KMS keys. Then it makes a best
|
|
16
16
|
* effort to delete the key material from the associated cluster. However, you might need to
|
|
17
17
|
* manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
18
18
|
* material</a> from the cluster and its backups.</p>
|
|
19
|
-
* <p>After all
|
|
20
|
-
* disconnect the key store from
|
|
21
|
-
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from
|
|
22
|
-
* disconnected, you cannot create or use the
|
|
23
|
-
* delete
|
|
19
|
+
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a> to
|
|
20
|
+
* disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
21
|
+
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
|
|
22
|
+
* disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
|
|
23
|
+
* delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
|
|
24
24
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
25
25
|
* properties.</p>
|
|
26
|
-
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in
|
|
27
|
-
* combines the convenience and extensive integration of
|
|
26
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
27
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
28
28
|
* single-tenant key store.</p>
|
|
29
29
|
*
|
|
30
30
|
* <p>
|
|
31
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
31
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
32
32
|
*
|
|
33
33
|
* <p>
|
|
34
34
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteCustomKeyStore</a> (IAM policy)</p>
|
|
@@ -7,18 +7,18 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
7
7
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
8
8
|
/**
|
|
9
9
|
* <p>Deletes key material that you previously imported. This operation makes the specified
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
* Material</a> in the <i>
|
|
13
|
-
* <p>When the specified
|
|
14
|
-
* not change the
|
|
10
|
+
* KMS key unusable. For more information about importing key material into
|
|
11
|
+
* KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
12
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
13
|
+
* <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does
|
|
14
|
+
* not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
15
15
|
* <code>PendingImport</code>.</p>
|
|
16
16
|
* <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
|
|
17
|
-
* the same key material into the
|
|
18
|
-
* <p>The
|
|
19
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
17
|
+
* the same key material into the KMS key.</p>
|
|
18
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
19
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
20
20
|
* <p>
|
|
21
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
21
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
22
22
|
*
|
|
23
23
|
* <p>
|
|
24
24
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteImportedKeyMaterial</a> (key policy)</p>
|