{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.KMS.CreateKey -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Creates a unique customer managed -- -- in your Amazon Web Services account and Region. You can use a KMS key in -- cryptographic operations, such as encryption and signing. Some Amazon -- Web Services services let you use KMS keys that you create and manage to -- protect your service resources. -- -- A KMS key is a logical representation of a cryptographic key. In -- addition to the key material used in cryptographic operations, a KMS key -- includes metadata, such as the key ID, key policy, creation date, -- description, and key state. For details, see -- -- in the /Key Management Service Developer Guide/ -- -- Use the parameters of @CreateKey@ to specify the type of KMS key, the -- source of its key material, its key policy, description, tags, and other -- properties. -- -- KMS has replaced the term /customer master key (CMK)/ with /KMS key/ and -- /KMS key/. The concept has not changed. To prevent breaking changes, KMS -- is keeping some variations of this term. -- -- To create different types of KMS keys, use the following guidance: -- -- [Symmetric encryption KMS key] -- By default, @CreateKey@ creates a symmetric encryption KMS key with -- key material that KMS generates. This is the basic and most widely -- used type of KMS key, and provides the best performance. -- -- To create a symmetric encryption KMS key, you don\'t need to specify -- any parameters. The default value for @KeySpec@, -- @SYMMETRIC_DEFAULT@, the default value for @KeyUsage@, -- @ENCRYPT_DECRYPT@, and the default value for @Origin@, @AWS_KMS@, -- create a symmetric encryption KMS key with KMS key material. -- -- If you need a key for basic encryption and decryption or you are -- creating a KMS key to protect your resources in an Amazon Web -- Services service, create a symmetric encryption KMS key. The key -- material in a symmetric encryption key never leaves KMS unencrypted. -- You can use a symmetric encryption KMS key to encrypt and decrypt -- data up to 4,096 bytes, but they are typically used to generate data -- keys and data keys pairs. For details, see GenerateDataKey and -- GenerateDataKeyPair. -- -- [Asymmetric KMS keys] -- To create an asymmetric KMS key, use the @KeySpec@ parameter to -- specify the type of key material in the KMS key. Then, use the -- @KeyUsage@ parameter to determine whether the KMS key will be used -- to encrypt and decrypt or sign and verify. You can\'t change these -- properties after the KMS key is created. -- -- Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) -- key pair, or an SM2 key pair (China Regions only). The private key -- in an asymmetric KMS key never leaves KMS unencrypted. However, you -- can use the GetPublicKey operation to download the public key so it -- can be used outside of KMS. KMS keys with RSA or SM2 key pairs can -- be used to encrypt or decrypt data or sign and verify messages (but -- not both). KMS keys with ECC key pairs can be used only to sign and -- verify messages. For information about asymmetric KMS keys, see -- -- in the /Key Management Service Developer Guide/. -- -- [HMAC KMS key] -- To create an HMAC KMS key, set the @KeySpec@ parameter to a key spec -- value for HMAC KMS keys. Then set the @KeyUsage@ parameter to -- @GENERATE_VERIFY_MAC@. You must set the key usage even though -- @GENERATE_VERIFY_MAC@ is the only valid key usage value for HMAC KMS -- keys. You can\'t change these properties after the KMS key is -- created. -- -- HMAC KMS keys are symmetric keys that never leave KMS unencrypted. -- You can use HMAC keys to generate (GenerateMac) and verify -- (VerifyMac) HMAC codes for messages up to 4096 bytes. -- -- HMAC KMS keys are not supported in all Amazon Web Services Regions. -- If you try to create an HMAC KMS key in an Amazon Web Services -- Region in which HMAC keys are not supported, the @CreateKey@ -- operation returns an @UnsupportedOperationException@. For a list of -- Regions in which HMAC KMS keys are supported, see -- -- in the /Key Management Service Developer Guide/. -- -- [Multi-Region primary keys -- Imported key material] -- To create a multi-Region /primary key/ in the local Amazon Web -- Services Region, use the @MultiRegion@ parameter with a value of -- @True@. To create a multi-Region /replica key/, that is, a KMS key -- with the same key ID and key material as a primary key, but in a -- different Amazon Web Services Region, use the ReplicateKey -- operation. To change a replica key to a primary key, and its primary -- key to a replica key, use the UpdatePrimaryRegion operation. -- -- You can create multi-Region KMS keys for all supported KMS key -- types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric -- encryption KMS keys, and asymmetric signing KMS keys. You can also -- create multi-Region keys with imported key material. However, you -- can\'t create multi-Region keys in a custom key store. -- -- This operation supports /multi-Region keys/, an KMS feature that -- lets you create multiple interoperable KMS keys in different Amazon -- Web Services Regions. Because these KMS keys have the same key ID, -- key material, and other metadata, you can use them interchangeably -- to encrypt data in one Amazon Web Services Region and decrypt 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 -- -- in the /Key Management Service Developer Guide/. -- -- To import your own key material into a KMS key, begin by creating a -- symmetric encryption KMS key with no key material. To do this, use -- the @Origin@ parameter of @CreateKey@ with a value of @EXTERNAL@. -- Next, use GetParametersForImport operation to get a public key and -- import token, and use the public key to encrypt your key material. -- Then, use ImportKeyMaterial with your import token to import the key -- material. For step-by-step instructions, see -- -- in the //Key Management Service Developer Guide// . -- -- This feature supports only symmetric encryption KMS keys, including -- multi-Region symmetric encryption KMS keys. You cannot import key -- material into any other type of KMS key. -- -- To create a multi-Region primary key with imported key material, use -- the @Origin@ parameter of @CreateKey@ with a value of @EXTERNAL@ and -- the @MultiRegion@ parameter with a value of @True@. To create -- replicas of the multi-Region primary key, use the ReplicateKey -- operation. For instructions, see -- . -- For more information about multi-Region keys, see -- -- in the /Key Management Service Developer Guide/. -- -- [Custom key store] -- A -- -- lets you protect your Amazon Web Services resources using keys in a -- backing key store that you own and manage. When you request a -- cryptographic operation with a KMS key in a custom key store, the -- operation is performed in the backing key store using its -- cryptographic keys. -- -- KMS supports -- -- backed by an CloudHSM cluster and -- -- backed by an external key manager outside of Amazon Web Services. -- When you create a KMS key in an CloudHSM key store, KMS generates an -- encryption key in the CloudHSM cluster and associates it with the -- KMS key. When you create a KMS key in an external key store, you -- specify an existing encryption key in the external key manager. -- -- Some external key managers provide a simpler method for creating a -- KMS key in an external key store. For details, see your external key -- manager documentation. -- -- Before you create a KMS key in a custom key store, the -- @ConnectionState@ of the key store must be @CONNECTED@. To connect -- the custom key store, use the ConnectCustomKeyStore operation. To -- find the @ConnectionState@, use the DescribeCustomKeyStores -- operation. -- -- To create a KMS key in a custom key store, use the -- @CustomKeyStoreId@. Use the default @KeySpec@ value, -- @SYMMETRIC_DEFAULT@, and the default @KeyUsage@ value, -- @ENCRYPT_DECRYPT@ to create a symmetric encryption key. No other key -- type is supported in a custom key store. -- -- To create a KMS key in an -- , -- use the @Origin@ parameter with a value of @AWS_CLOUDHSM@. The -- CloudHSM cluster that is associated with the custom key store must -- have at least two active HSMs in different Availability Zones in the -- Amazon Web Services Region. -- -- To create a KMS key in an -- , -- use the @Origin@ parameter with a value of @EXTERNAL_KEY_STORE@ and -- an @XksKeyId@ parameter that identifies an existing external key. -- -- Some external key managers provide a simpler method for creating a -- KMS key in an external key store. For details, see your external key -- manager documentation. -- -- __Cross-account use__: No. You cannot use this operation to create a KMS -- key in a different Amazon Web Services account. -- -- __Required permissions__: -- -- (IAM policy). To use the @Tags@ parameter, -- -- (IAM policy). For examples and information about related permissions, -- see -- -- in the /Key Management Service Developer Guide/. -- -- __Related operations:__ -- -- - DescribeKey -- -- - ListKeys -- -- - ScheduleKeyDeletion module Amazonka.KMS.CreateKey ( -- * Creating a Request CreateKey (..), newCreateKey, -- * Request Lenses createKey_bypassPolicyLockoutSafetyCheck, createKey_customKeyStoreId, createKey_customerMasterKeySpec, createKey_description, createKey_keySpec, createKey_keyUsage, createKey_multiRegion, createKey_origin, createKey_policy, createKey_tags, createKey_xksKeyId, -- * Destructuring the Response CreateKeyResponse (..), newCreateKeyResponse, -- * Response Lenses createKeyResponse_keyMetadata, createKeyResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.KMS.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newCreateKey' smart constructor. data CreateKey = CreateKey' { -- | A flag to indicate whether to bypass the key policy lockout safety -- check. -- -- Setting this value to true increases the risk that the KMS key becomes -- unmanageable. Do not set this value to true indiscriminately. -- -- For more information, refer to the scenario in the -- -- section in the //Key Management Service Developer Guide// . -- -- Use this parameter only when you include a policy in the request and you -- intend to prevent the principal that is making the request from making a -- subsequent PutKeyPolicy request on the KMS key. -- -- The default value is false. bypassPolicyLockoutSafetyCheck :: Prelude.Maybe Prelude.Bool, -- | Creates the KMS key in the specified -- . -- The @ConnectionState@ of the custom key store must be @CONNECTED@. To -- find the CustomKeyStoreID and ConnectionState use the -- DescribeCustomKeyStores operation. -- -- This parameter is valid only for symmetric encryption KMS keys in a -- single Region. You cannot create any other type of KMS key in a custom -- key store. -- -- When you create a KMS key in an CloudHSM key store, KMS generates a -- non-exportable 256-bit symmetric key in its associated CloudHSM cluster -- and associates it with the KMS key. When you create a KMS key in an -- external key store, you must use the @XksKeyId@ parameter to specify an -- external key that serves as key material for the KMS key. customKeyStoreId :: Prelude.Maybe Prelude.Text, -- | Instead, use the @KeySpec@ parameter. -- -- The @KeySpec@ and @CustomerMasterKeySpec@ parameters work the same way. -- Only the names differ. We recommend that you use @KeySpec@ parameter in -- your code. However, to avoid breaking changes, KMS supports both -- parameters. customerMasterKeySpec :: Prelude.Maybe CustomerMasterKeySpec, -- | A description of the KMS key. -- -- Use a description that helps you decide whether the KMS key is -- appropriate for a task. The default value is an empty string (no -- description). -- -- To set or change the description after the key is created, use -- UpdateKeyDescription. description :: Prelude.Maybe Prelude.Text, -- | Specifies the type of KMS key to create. The default value, -- @SYMMETRIC_DEFAULT@, creates a KMS key with a 256-bit AES-GCM key that -- is used for encryption and decryption, except in China Regions, where it -- creates a 128-bit symmetric key that uses SM4 encryption. For help -- choosing a key spec for your KMS key, see -- -- in the //Key Management Service Developer Guide// . -- -- The @KeySpec@ determines whether the KMS key contains a symmetric key or -- an asymmetric key pair. It also determines the algorithms that the KMS -- key supports. You can\'t change the @KeySpec@ after the KMS key is -- created. To further restrict the algorithms that can be used with the -- KMS key, use a condition key in its key policy or IAM policy. For more -- information, see -- , -- -- or -- -- in the //Key Management Service Developer Guide// . -- -- -- use symmetric encryption KMS keys to protect your data. These services -- do not support asymmetric KMS keys or HMAC KMS keys. -- -- KMS supports the following key specs for KMS keys: -- -- - Symmetric encryption key (default) -- -- - @SYMMETRIC_DEFAULT@ -- -- - HMAC keys (symmetric) -- -- - @HMAC_224@ -- -- - @HMAC_256@ -- -- - @HMAC_384@ -- -- - @HMAC_512@ -- -- - Asymmetric RSA key pairs -- -- - @RSA_2048@ -- -- - @RSA_3072@ -- -- - @RSA_4096@ -- -- - Asymmetric NIST-recommended elliptic curve key pairs -- -- - @ECC_NIST_P256@ (secp256r1) -- -- - @ECC_NIST_P384@ (secp384r1) -- -- - @ECC_NIST_P521@ (secp521r1) -- -- - Other asymmetric elliptic curve key pairs -- -- - @ECC_SECG_P256K1@ (secp256k1), commonly used for -- cryptocurrencies. -- -- - SM2 key pairs (China Regions only) -- -- - @SM2@ keySpec :: Prelude.Maybe KeySpec, -- | Determines the -- -- for which you can use the KMS key. The default value is -- @ENCRYPT_DECRYPT@. This parameter is optional when you are creating a -- symmetric encryption KMS key; otherwise, it is required. You can\'t -- change the @KeyUsage@ value after the KMS key is created. -- -- Select only one valid value. -- -- - For symmetric encryption KMS keys, omit the parameter or specify -- @ENCRYPT_DECRYPT@. -- -- - For HMAC KMS keys (symmetric), specify @GENERATE_VERIFY_MAC@. -- -- - For asymmetric KMS keys with RSA key material, specify -- @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with ECC key material, specify -- @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with SM2 key material (China Regions only), -- specify @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. keyUsage :: Prelude.Maybe KeyUsageType, -- | Creates a multi-Region primary key that you can replicate into other -- Amazon Web Services Regions. You cannot change this value after you -- create the KMS key. -- -- For a multi-Region key, set this parameter to @True@. For a -- single-Region KMS key, omit this parameter or set it to @False@. The -- default value is @False@. -- -- This operation supports /multi-Region keys/, an KMS feature that lets -- you create multiple interoperable KMS keys in different Amazon Web -- Services Regions. Because these KMS keys have the same key ID, key -- material, and other metadata, you can use them interchangeably to -- encrypt data in one Amazon Web Services Region and decrypt 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 -- -- in the /Key Management Service Developer Guide/. -- -- This value creates a /primary key/, not a replica. To create a /replica -- key/, use the ReplicateKey operation. -- -- You can create a symmetric or asymmetric multi-Region key, and you can -- create a multi-Region key with imported key material. However, you -- cannot create a multi-Region key in a custom key store. multiRegion :: Prelude.Maybe Prelude.Bool, -- | The source of the key material for the KMS key. You cannot change the -- origin after you create the KMS key. The default is @AWS_KMS@, which -- means that KMS creates the key material. -- -- To -- -- (for imported key material), set this value to @EXTERNAL@. For more -- information about importing key material into KMS, see -- -- in the /Key Management Service Developer Guide/. The @EXTERNAL@ origin -- value is valid only for symmetric KMS keys. -- -- To -- -- and create its key material in the associated CloudHSM cluster, set this -- value to @AWS_CLOUDHSM@. You must also use the @CustomKeyStoreId@ -- parameter to identify the CloudHSM key store. The @KeySpec@ value must -- be @SYMMETRIC_DEFAULT@. -- -- To -- , -- set this value to @EXTERNAL_KEY_STORE@. You must also use the -- @CustomKeyStoreId@ parameter to identify the external key store and the -- @XksKeyId@ parameter to identify the associated external key. The -- @KeySpec@ value must be @SYMMETRIC_DEFAULT@. origin :: Prelude.Maybe OriginType, -- | The key policy to attach to the KMS key. -- -- If you provide a key policy, it must meet the following criteria: -- -- - If you don\'t set @BypassPolicyLockoutSafetyCheck@ to true, the key -- policy must allow the principal that is making the @CreateKey@ -- request to make a subsequent PutKeyPolicy request on the KMS key. -- This reduces the risk that the KMS key becomes unmanageable. For -- more information, refer to the scenario in the -- -- section of the //Key Management Service Developer Guide// . -- -- - Each statement in the key policy must contain one or more -- principals. The principals in the key policy must exist and be -- visible to KMS. When you create a new Amazon Web Services principal -- (for example, an IAM user or role), you might need to enforce a -- delay before including the new principal in a key policy because the -- new principal might not be immediately visible to KMS. For more -- information, see -- -- in the /Amazon Web Services Identity and Access Management User -- Guide/. -- -- If you do not provide a key policy, KMS attaches a default key policy to -- the KMS key. For more information, see -- -- in the /Key Management Service Developer Guide/. -- -- The key policy size quota is 32 kilobytes (32768 bytes). -- -- For help writing and formatting a JSON policy document, see the -- -- in the //Identity and Access Management User Guide// . policy :: Prelude.Maybe Prelude.Text, -- | Assigns one or more tags to the KMS key. Use this parameter to tag the -- KMS key when it is created. To tag an existing KMS key, use the -- TagResource operation. -- -- Tagging or untagging a KMS key can allow or deny permission to the KMS -- key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- To use this parameter, you must have -- -- permission in an IAM policy. -- -- Each tag consists of a tag key and a tag value. Both the tag key and the -- tag value are required, but the tag value can be an empty (null) string. -- You cannot have more than one tag on a KMS key with the same tag key. If -- you specify an existing tag key with a different tag value, KMS replaces -- the current tag value with the specified one. -- -- When you add tags to an Amazon Web Services resource, Amazon Web -- Services generates a cost allocation report with usage and costs -- aggregated by tags. Tags can also be used to control access to a KMS -- key. For details, see -- . tags :: Prelude.Maybe [Tag], -- | Identifies the -- -- that serves as key material for the KMS key in an -- . -- Specify the ID that the -- -- uses to refer to the external key. For help, see the documentation for -- your external key store proxy. -- -- This parameter is required for a KMS key with an @Origin@ value of -- @EXTERNAL_KEY_STORE@. It is not valid for KMS keys with any other -- @Origin@ value. -- -- The external key must be an existing 256-bit AES symmetric encryption -- key hosted outside of Amazon Web Services in an external key manager -- associated with the external key store specified by the -- @CustomKeyStoreId@ parameter. This key must be enabled and configured to -- perform encryption and decryption. Each KMS key in an external key store -- must use a different external key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- Each KMS key in an external key store is associated two backing keys. -- One is key material that KMS generates. The other is the external key -- specified by this parameter. When you use the KMS key in an external key -- store to encrypt data, the encryption operation is performed first by -- KMS using the KMS key material, and then by the external key manager -- using the specified external key, a process known as /double -- encryption/. For details, see -- -- in the /Key Management Service Developer Guide/. xksKeyId :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateKey' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'bypassPolicyLockoutSafetyCheck', 'createKey_bypassPolicyLockoutSafetyCheck' - A flag to indicate whether to bypass the key policy lockout safety -- check. -- -- Setting this value to true increases the risk that the KMS key becomes -- unmanageable. Do not set this value to true indiscriminately. -- -- For more information, refer to the scenario in the -- -- section in the //Key Management Service Developer Guide// . -- -- Use this parameter only when you include a policy in the request and you -- intend to prevent the principal that is making the request from making a -- subsequent PutKeyPolicy request on the KMS key. -- -- The default value is false. -- -- 'customKeyStoreId', 'createKey_customKeyStoreId' - Creates the KMS key in the specified -- . -- The @ConnectionState@ of the custom key store must be @CONNECTED@. To -- find the CustomKeyStoreID and ConnectionState use the -- DescribeCustomKeyStores operation. -- -- This parameter is valid only for symmetric encryption KMS keys in a -- single Region. You cannot create any other type of KMS key in a custom -- key store. -- -- When you create a KMS key in an CloudHSM key store, KMS generates a -- non-exportable 256-bit symmetric key in its associated CloudHSM cluster -- and associates it with the KMS key. When you create a KMS key in an -- external key store, you must use the @XksKeyId@ parameter to specify an -- external key that serves as key material for the KMS key. -- -- 'customerMasterKeySpec', 'createKey_customerMasterKeySpec' - Instead, use the @KeySpec@ parameter. -- -- The @KeySpec@ and @CustomerMasterKeySpec@ parameters work the same way. -- Only the names differ. We recommend that you use @KeySpec@ parameter in -- your code. However, to avoid breaking changes, KMS supports both -- parameters. -- -- 'description', 'createKey_description' - A description of the KMS key. -- -- Use a description that helps you decide whether the KMS key is -- appropriate for a task. The default value is an empty string (no -- description). -- -- To set or change the description after the key is created, use -- UpdateKeyDescription. -- -- 'keySpec', 'createKey_keySpec' - Specifies the type of KMS key to create. The default value, -- @SYMMETRIC_DEFAULT@, creates a KMS key with a 256-bit AES-GCM key that -- is used for encryption and decryption, except in China Regions, where it -- creates a 128-bit symmetric key that uses SM4 encryption. For help -- choosing a key spec for your KMS key, see -- -- in the //Key Management Service Developer Guide// . -- -- The @KeySpec@ determines whether the KMS key contains a symmetric key or -- an asymmetric key pair. It also determines the algorithms that the KMS -- key supports. You can\'t change the @KeySpec@ after the KMS key is -- created. To further restrict the algorithms that can be used with the -- KMS key, use a condition key in its key policy or IAM policy. For more -- information, see -- , -- -- or -- -- in the //Key Management Service Developer Guide// . -- -- -- use symmetric encryption KMS keys to protect your data. These services -- do not support asymmetric KMS keys or HMAC KMS keys. -- -- KMS supports the following key specs for KMS keys: -- -- - Symmetric encryption key (default) -- -- - @SYMMETRIC_DEFAULT@ -- -- - HMAC keys (symmetric) -- -- - @HMAC_224@ -- -- - @HMAC_256@ -- -- - @HMAC_384@ -- -- - @HMAC_512@ -- -- - Asymmetric RSA key pairs -- -- - @RSA_2048@ -- -- - @RSA_3072@ -- -- - @RSA_4096@ -- -- - Asymmetric NIST-recommended elliptic curve key pairs -- -- - @ECC_NIST_P256@ (secp256r1) -- -- - @ECC_NIST_P384@ (secp384r1) -- -- - @ECC_NIST_P521@ (secp521r1) -- -- - Other asymmetric elliptic curve key pairs -- -- - @ECC_SECG_P256K1@ (secp256k1), commonly used for -- cryptocurrencies. -- -- - SM2 key pairs (China Regions only) -- -- - @SM2@ -- -- 'keyUsage', 'createKey_keyUsage' - Determines the -- -- for which you can use the KMS key. The default value is -- @ENCRYPT_DECRYPT@. This parameter is optional when you are creating a -- symmetric encryption KMS key; otherwise, it is required. You can\'t -- change the @KeyUsage@ value after the KMS key is created. -- -- Select only one valid value. -- -- - For symmetric encryption KMS keys, omit the parameter or specify -- @ENCRYPT_DECRYPT@. -- -- - For HMAC KMS keys (symmetric), specify @GENERATE_VERIFY_MAC@. -- -- - For asymmetric KMS keys with RSA key material, specify -- @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with ECC key material, specify -- @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with SM2 key material (China Regions only), -- specify @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. -- -- 'multiRegion', 'createKey_multiRegion' - Creates a multi-Region primary key that you can replicate into other -- Amazon Web Services Regions. You cannot change this value after you -- create the KMS key. -- -- For a multi-Region key, set this parameter to @True@. For a -- single-Region KMS key, omit this parameter or set it to @False@. The -- default value is @False@. -- -- This operation supports /multi-Region keys/, an KMS feature that lets -- you create multiple interoperable KMS keys in different Amazon Web -- Services Regions. Because these KMS keys have the same key ID, key -- material, and other metadata, you can use them interchangeably to -- encrypt data in one Amazon Web Services Region and decrypt 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 -- -- in the /Key Management Service Developer Guide/. -- -- This value creates a /primary key/, not a replica. To create a /replica -- key/, use the ReplicateKey operation. -- -- You can create a symmetric or asymmetric multi-Region key, and you can -- create a multi-Region key with imported key material. However, you -- cannot create a multi-Region key in a custom key store. -- -- 'origin', 'createKey_origin' - The source of the key material for the KMS key. You cannot change the -- origin after you create the KMS key. The default is @AWS_KMS@, which -- means that KMS creates the key material. -- -- To -- -- (for imported key material), set this value to @EXTERNAL@. For more -- information about importing key material into KMS, see -- -- in the /Key Management Service Developer Guide/. The @EXTERNAL@ origin -- value is valid only for symmetric KMS keys. -- -- To -- -- and create its key material in the associated CloudHSM cluster, set this -- value to @AWS_CLOUDHSM@. You must also use the @CustomKeyStoreId@ -- parameter to identify the CloudHSM key store. The @KeySpec@ value must -- be @SYMMETRIC_DEFAULT@. -- -- To -- , -- set this value to @EXTERNAL_KEY_STORE@. You must also use the -- @CustomKeyStoreId@ parameter to identify the external key store and the -- @XksKeyId@ parameter to identify the associated external key. The -- @KeySpec@ value must be @SYMMETRIC_DEFAULT@. -- -- 'policy', 'createKey_policy' - The key policy to attach to the KMS key. -- -- If you provide a key policy, it must meet the following criteria: -- -- - If you don\'t set @BypassPolicyLockoutSafetyCheck@ to true, the key -- policy must allow the principal that is making the @CreateKey@ -- request to make a subsequent PutKeyPolicy request on the KMS key. -- This reduces the risk that the KMS key becomes unmanageable. For -- more information, refer to the scenario in the -- -- section of the //Key Management Service Developer Guide// . -- -- - Each statement in the key policy must contain one or more -- principals. The principals in the key policy must exist and be -- visible to KMS. When you create a new Amazon Web Services principal -- (for example, an IAM user or role), you might need to enforce a -- delay before including the new principal in a key policy because the -- new principal might not be immediately visible to KMS. For more -- information, see -- -- in the /Amazon Web Services Identity and Access Management User -- Guide/. -- -- If you do not provide a key policy, KMS attaches a default key policy to -- the KMS key. For more information, see -- -- in the /Key Management Service Developer Guide/. -- -- The key policy size quota is 32 kilobytes (32768 bytes). -- -- For help writing and formatting a JSON policy document, see the -- -- in the //Identity and Access Management User Guide// . -- -- 'tags', 'createKey_tags' - Assigns one or more tags to the KMS key. Use this parameter to tag the -- KMS key when it is created. To tag an existing KMS key, use the -- TagResource operation. -- -- Tagging or untagging a KMS key can allow or deny permission to the KMS -- key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- To use this parameter, you must have -- -- permission in an IAM policy. -- -- Each tag consists of a tag key and a tag value. Both the tag key and the -- tag value are required, but the tag value can be an empty (null) string. -- You cannot have more than one tag on a KMS key with the same tag key. If -- you specify an existing tag key with a different tag value, KMS replaces -- the current tag value with the specified one. -- -- When you add tags to an Amazon Web Services resource, Amazon Web -- Services generates a cost allocation report with usage and costs -- aggregated by tags. Tags can also be used to control access to a KMS -- key. For details, see -- . -- -- 'xksKeyId', 'createKey_xksKeyId' - Identifies the -- -- that serves as key material for the KMS key in an -- . -- Specify the ID that the -- -- uses to refer to the external key. For help, see the documentation for -- your external key store proxy. -- -- This parameter is required for a KMS key with an @Origin@ value of -- @EXTERNAL_KEY_STORE@. It is not valid for KMS keys with any other -- @Origin@ value. -- -- The external key must be an existing 256-bit AES symmetric encryption -- key hosted outside of Amazon Web Services in an external key manager -- associated with the external key store specified by the -- @CustomKeyStoreId@ parameter. This key must be enabled and configured to -- perform encryption and decryption. Each KMS key in an external key store -- must use a different external key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- Each KMS key in an external key store is associated two backing keys. -- One is key material that KMS generates. The other is the external key -- specified by this parameter. When you use the KMS key in an external key -- store to encrypt data, the encryption operation is performed first by -- KMS using the KMS key material, and then by the external key manager -- using the specified external key, a process known as /double -- encryption/. For details, see -- -- in the /Key Management Service Developer Guide/. newCreateKey :: CreateKey newCreateKey = CreateKey' { bypassPolicyLockoutSafetyCheck = Prelude.Nothing, customKeyStoreId = Prelude.Nothing, customerMasterKeySpec = Prelude.Nothing, description = Prelude.Nothing, keySpec = Prelude.Nothing, keyUsage = Prelude.Nothing, multiRegion = Prelude.Nothing, origin = Prelude.Nothing, policy = Prelude.Nothing, tags = Prelude.Nothing, xksKeyId = Prelude.Nothing } -- | A flag to indicate whether to bypass the key policy lockout safety -- check. -- -- Setting this value to true increases the risk that the KMS key becomes -- unmanageable. Do not set this value to true indiscriminately. -- -- For more information, refer to the scenario in the -- -- section in the //Key Management Service Developer Guide// . -- -- Use this parameter only when you include a policy in the request and you -- intend to prevent the principal that is making the request from making a -- subsequent PutKeyPolicy request on the KMS key. -- -- The default value is false. createKey_bypassPolicyLockoutSafetyCheck :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Bool) createKey_bypassPolicyLockoutSafetyCheck = Lens.lens (\CreateKey' {bypassPolicyLockoutSafetyCheck} -> bypassPolicyLockoutSafetyCheck) (\s@CreateKey' {} a -> s {bypassPolicyLockoutSafetyCheck = a} :: CreateKey) -- | Creates the KMS key in the specified -- . -- The @ConnectionState@ of the custom key store must be @CONNECTED@. To -- find the CustomKeyStoreID and ConnectionState use the -- DescribeCustomKeyStores operation. -- -- This parameter is valid only for symmetric encryption KMS keys in a -- single Region. You cannot create any other type of KMS key in a custom -- key store. -- -- When you create a KMS key in an CloudHSM key store, KMS generates a -- non-exportable 256-bit symmetric key in its associated CloudHSM cluster -- and associates it with the KMS key. When you create a KMS key in an -- external key store, you must use the @XksKeyId@ parameter to specify an -- external key that serves as key material for the KMS key. createKey_customKeyStoreId :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Text) createKey_customKeyStoreId = Lens.lens (\CreateKey' {customKeyStoreId} -> customKeyStoreId) (\s@CreateKey' {} a -> s {customKeyStoreId = a} :: CreateKey) -- | Instead, use the @KeySpec@ parameter. -- -- The @KeySpec@ and @CustomerMasterKeySpec@ parameters work the same way. -- Only the names differ. We recommend that you use @KeySpec@ parameter in -- your code. However, to avoid breaking changes, KMS supports both -- parameters. createKey_customerMasterKeySpec :: Lens.Lens' CreateKey (Prelude.Maybe CustomerMasterKeySpec) createKey_customerMasterKeySpec = Lens.lens (\CreateKey' {customerMasterKeySpec} -> customerMasterKeySpec) (\s@CreateKey' {} a -> s {customerMasterKeySpec = a} :: CreateKey) -- | A description of the KMS key. -- -- Use a description that helps you decide whether the KMS key is -- appropriate for a task. The default value is an empty string (no -- description). -- -- To set or change the description after the key is created, use -- UpdateKeyDescription. createKey_description :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Text) createKey_description = Lens.lens (\CreateKey' {description} -> description) (\s@CreateKey' {} a -> s {description = a} :: CreateKey) -- | Specifies the type of KMS key to create. The default value, -- @SYMMETRIC_DEFAULT@, creates a KMS key with a 256-bit AES-GCM key that -- is used for encryption and decryption, except in China Regions, where it -- creates a 128-bit symmetric key that uses SM4 encryption. For help -- choosing a key spec for your KMS key, see -- -- in the //Key Management Service Developer Guide// . -- -- The @KeySpec@ determines whether the KMS key contains a symmetric key or -- an asymmetric key pair. It also determines the algorithms that the KMS -- key supports. You can\'t change the @KeySpec@ after the KMS key is -- created. To further restrict the algorithms that can be used with the -- KMS key, use a condition key in its key policy or IAM policy. For more -- information, see -- , -- -- or -- -- in the //Key Management Service Developer Guide// . -- -- -- use symmetric encryption KMS keys to protect your data. These services -- do not support asymmetric KMS keys or HMAC KMS keys. -- -- KMS supports the following key specs for KMS keys: -- -- - Symmetric encryption key (default) -- -- - @SYMMETRIC_DEFAULT@ -- -- - HMAC keys (symmetric) -- -- - @HMAC_224@ -- -- - @HMAC_256@ -- -- - @HMAC_384@ -- -- - @HMAC_512@ -- -- - Asymmetric RSA key pairs -- -- - @RSA_2048@ -- -- - @RSA_3072@ -- -- - @RSA_4096@ -- -- - Asymmetric NIST-recommended elliptic curve key pairs -- -- - @ECC_NIST_P256@ (secp256r1) -- -- - @ECC_NIST_P384@ (secp384r1) -- -- - @ECC_NIST_P521@ (secp521r1) -- -- - Other asymmetric elliptic curve key pairs -- -- - @ECC_SECG_P256K1@ (secp256k1), commonly used for -- cryptocurrencies. -- -- - SM2 key pairs (China Regions only) -- -- - @SM2@ createKey_keySpec :: Lens.Lens' CreateKey (Prelude.Maybe KeySpec) createKey_keySpec = Lens.lens (\CreateKey' {keySpec} -> keySpec) (\s@CreateKey' {} a -> s {keySpec = a} :: CreateKey) -- | Determines the -- -- for which you can use the KMS key. The default value is -- @ENCRYPT_DECRYPT@. This parameter is optional when you are creating a -- symmetric encryption KMS key; otherwise, it is required. You can\'t -- change the @KeyUsage@ value after the KMS key is created. -- -- Select only one valid value. -- -- - For symmetric encryption KMS keys, omit the parameter or specify -- @ENCRYPT_DECRYPT@. -- -- - For HMAC KMS keys (symmetric), specify @GENERATE_VERIFY_MAC@. -- -- - For asymmetric KMS keys with RSA key material, specify -- @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with ECC key material, specify -- @SIGN_VERIFY@. -- -- - For asymmetric KMS keys with SM2 key material (China Regions only), -- specify @ENCRYPT_DECRYPT@ or @SIGN_VERIFY@. createKey_keyUsage :: Lens.Lens' CreateKey (Prelude.Maybe KeyUsageType) createKey_keyUsage = Lens.lens (\CreateKey' {keyUsage} -> keyUsage) (\s@CreateKey' {} a -> s {keyUsage = a} :: CreateKey) -- | Creates a multi-Region primary key that you can replicate into other -- Amazon Web Services Regions. You cannot change this value after you -- create the KMS key. -- -- For a multi-Region key, set this parameter to @True@. For a -- single-Region KMS key, omit this parameter or set it to @False@. The -- default value is @False@. -- -- This operation supports /multi-Region keys/, an KMS feature that lets -- you create multiple interoperable KMS keys in different Amazon Web -- Services Regions. Because these KMS keys have the same key ID, key -- material, and other metadata, you can use them interchangeably to -- encrypt data in one Amazon Web Services Region and decrypt 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 -- -- in the /Key Management Service Developer Guide/. -- -- This value creates a /primary key/, not a replica. To create a /replica -- key/, use the ReplicateKey operation. -- -- You can create a symmetric or asymmetric multi-Region key, and you can -- create a multi-Region key with imported key material. However, you -- cannot create a multi-Region key in a custom key store. createKey_multiRegion :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Bool) createKey_multiRegion = Lens.lens (\CreateKey' {multiRegion} -> multiRegion) (\s@CreateKey' {} a -> s {multiRegion = a} :: CreateKey) -- | The source of the key material for the KMS key. You cannot change the -- origin after you create the KMS key. The default is @AWS_KMS@, which -- means that KMS creates the key material. -- -- To -- -- (for imported key material), set this value to @EXTERNAL@. For more -- information about importing key material into KMS, see -- -- in the /Key Management Service Developer Guide/. The @EXTERNAL@ origin -- value is valid only for symmetric KMS keys. -- -- To -- -- and create its key material in the associated CloudHSM cluster, set this -- value to @AWS_CLOUDHSM@. You must also use the @CustomKeyStoreId@ -- parameter to identify the CloudHSM key store. The @KeySpec@ value must -- be @SYMMETRIC_DEFAULT@. -- -- To -- , -- set this value to @EXTERNAL_KEY_STORE@. You must also use the -- @CustomKeyStoreId@ parameter to identify the external key store and the -- @XksKeyId@ parameter to identify the associated external key. The -- @KeySpec@ value must be @SYMMETRIC_DEFAULT@. createKey_origin :: Lens.Lens' CreateKey (Prelude.Maybe OriginType) createKey_origin = Lens.lens (\CreateKey' {origin} -> origin) (\s@CreateKey' {} a -> s {origin = a} :: CreateKey) -- | The key policy to attach to the KMS key. -- -- If you provide a key policy, it must meet the following criteria: -- -- - If you don\'t set @BypassPolicyLockoutSafetyCheck@ to true, the key -- policy must allow the principal that is making the @CreateKey@ -- request to make a subsequent PutKeyPolicy request on the KMS key. -- This reduces the risk that the KMS key becomes unmanageable. For -- more information, refer to the scenario in the -- -- section of the //Key Management Service Developer Guide// . -- -- - Each statement in the key policy must contain one or more -- principals. The principals in the key policy must exist and be -- visible to KMS. When you create a new Amazon Web Services principal -- (for example, an IAM user or role), you might need to enforce a -- delay before including the new principal in a key policy because the -- new principal might not be immediately visible to KMS. For more -- information, see -- -- in the /Amazon Web Services Identity and Access Management User -- Guide/. -- -- If you do not provide a key policy, KMS attaches a default key policy to -- the KMS key. For more information, see -- -- in the /Key Management Service Developer Guide/. -- -- The key policy size quota is 32 kilobytes (32768 bytes). -- -- For help writing and formatting a JSON policy document, see the -- -- in the //Identity and Access Management User Guide// . createKey_policy :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Text) createKey_policy = Lens.lens (\CreateKey' {policy} -> policy) (\s@CreateKey' {} a -> s {policy = a} :: CreateKey) -- | Assigns one or more tags to the KMS key. Use this parameter to tag the -- KMS key when it is created. To tag an existing KMS key, use the -- TagResource operation. -- -- Tagging or untagging a KMS key can allow or deny permission to the KMS -- key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- To use this parameter, you must have -- -- permission in an IAM policy. -- -- Each tag consists of a tag key and a tag value. Both the tag key and the -- tag value are required, but the tag value can be an empty (null) string. -- You cannot have more than one tag on a KMS key with the same tag key. If -- you specify an existing tag key with a different tag value, KMS replaces -- the current tag value with the specified one. -- -- When you add tags to an Amazon Web Services resource, Amazon Web -- Services generates a cost allocation report with usage and costs -- aggregated by tags. Tags can also be used to control access to a KMS -- key. For details, see -- . createKey_tags :: Lens.Lens' CreateKey (Prelude.Maybe [Tag]) createKey_tags = Lens.lens (\CreateKey' {tags} -> tags) (\s@CreateKey' {} a -> s {tags = a} :: CreateKey) Prelude.. Lens.mapping Lens.coerced -- | Identifies the -- -- that serves as key material for the KMS key in an -- . -- Specify the ID that the -- -- uses to refer to the external key. For help, see the documentation for -- your external key store proxy. -- -- This parameter is required for a KMS key with an @Origin@ value of -- @EXTERNAL_KEY_STORE@. It is not valid for KMS keys with any other -- @Origin@ value. -- -- The external key must be an existing 256-bit AES symmetric encryption -- key hosted outside of Amazon Web Services in an external key manager -- associated with the external key store specified by the -- @CustomKeyStoreId@ parameter. This key must be enabled and configured to -- perform encryption and decryption. Each KMS key in an external key store -- must use a different external key. For details, see -- -- in the /Key Management Service Developer Guide/. -- -- Each KMS key in an external key store is associated two backing keys. -- One is key material that KMS generates. The other is the external key -- specified by this parameter. When you use the KMS key in an external key -- store to encrypt data, the encryption operation is performed first by -- KMS using the KMS key material, and then by the external key manager -- using the specified external key, a process known as /double -- encryption/. For details, see -- -- in the /Key Management Service Developer Guide/. createKey_xksKeyId :: Lens.Lens' CreateKey (Prelude.Maybe Prelude.Text) createKey_xksKeyId = Lens.lens (\CreateKey' {xksKeyId} -> xksKeyId) (\s@CreateKey' {} a -> s {xksKeyId = a} :: CreateKey) instance Core.AWSRequest CreateKey where type AWSResponse CreateKey = CreateKeyResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> CreateKeyResponse' Prelude.<$> (x Data..?> "KeyMetadata") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable CreateKey where hashWithSalt _salt CreateKey' {..} = _salt `Prelude.hashWithSalt` bypassPolicyLockoutSafetyCheck `Prelude.hashWithSalt` customKeyStoreId `Prelude.hashWithSalt` customerMasterKeySpec `Prelude.hashWithSalt` description `Prelude.hashWithSalt` keySpec `Prelude.hashWithSalt` keyUsage `Prelude.hashWithSalt` multiRegion `Prelude.hashWithSalt` origin `Prelude.hashWithSalt` policy `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` xksKeyId instance Prelude.NFData CreateKey where rnf CreateKey' {..} = Prelude.rnf bypassPolicyLockoutSafetyCheck `Prelude.seq` Prelude.rnf customKeyStoreId `Prelude.seq` Prelude.rnf customerMasterKeySpec `Prelude.seq` Prelude.rnf description `Prelude.seq` Prelude.rnf keySpec `Prelude.seq` Prelude.rnf keyUsage `Prelude.seq` Prelude.rnf multiRegion `Prelude.seq` Prelude.rnf origin `Prelude.seq` Prelude.rnf policy `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf xksKeyId instance Data.ToHeaders CreateKey where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ("TrentService.CreateKey" :: Prelude.ByteString), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON CreateKey where toJSON CreateKey' {..} = Data.object ( Prelude.catMaybes [ ("BypassPolicyLockoutSafetyCheck" Data..=) Prelude.<$> bypassPolicyLockoutSafetyCheck, ("CustomKeyStoreId" Data..=) Prelude.<$> customKeyStoreId, ("CustomerMasterKeySpec" Data..=) Prelude.<$> customerMasterKeySpec, ("Description" Data..=) Prelude.<$> description, ("KeySpec" Data..=) Prelude.<$> keySpec, ("KeyUsage" Data..=) Prelude.<$> keyUsage, ("MultiRegion" Data..=) Prelude.<$> multiRegion, ("Origin" Data..=) Prelude.<$> origin, ("Policy" Data..=) Prelude.<$> policy, ("Tags" Data..=) Prelude.<$> tags, ("XksKeyId" Data..=) Prelude.<$> xksKeyId ] ) instance Data.ToPath CreateKey where toPath = Prelude.const "/" instance Data.ToQuery CreateKey where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newCreateKeyResponse' smart constructor. data CreateKeyResponse = CreateKeyResponse' { -- | Metadata associated with the KMS key. keyMetadata :: Prelude.Maybe KeyMetadata, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateKeyResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'keyMetadata', 'createKeyResponse_keyMetadata' - Metadata associated with the KMS key. -- -- 'httpStatus', 'createKeyResponse_httpStatus' - The response's http status code. newCreateKeyResponse :: -- | 'httpStatus' Prelude.Int -> CreateKeyResponse newCreateKeyResponse pHttpStatus_ = CreateKeyResponse' { keyMetadata = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Metadata associated with the KMS key. createKeyResponse_keyMetadata :: Lens.Lens' CreateKeyResponse (Prelude.Maybe KeyMetadata) createKeyResponse_keyMetadata = Lens.lens (\CreateKeyResponse' {keyMetadata} -> keyMetadata) (\s@CreateKeyResponse' {} a -> s {keyMetadata = a} :: CreateKeyResponse) -- | The response's http status code. createKeyResponse_httpStatus :: Lens.Lens' CreateKeyResponse Prelude.Int createKeyResponse_httpStatus = Lens.lens (\CreateKeyResponse' {httpStatus} -> httpStatus) (\s@CreateKeyResponse' {} a -> s {httpStatus = a} :: CreateKeyResponse) instance Prelude.NFData CreateKeyResponse where rnf CreateKeyResponse' {..} = Prelude.rnf keyMetadata `Prelude.seq` Prelude.rnf httpStatus