Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide .
You must specify the key ID of the CMK to import the key material into. This CMK's Origin
must be EXTERNAL
. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport
response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to Enabled
, and you can use the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
- importKeyMaterial :: Text -> ByteString -> ByteString -> ImportKeyMaterial
- data ImportKeyMaterial
- ikmExpirationModel :: Lens' ImportKeyMaterial (Maybe ExpirationModelType)
- ikmValidTo :: Lens' ImportKeyMaterial (Maybe UTCTime)
- ikmKeyId :: Lens' ImportKeyMaterial Text
- ikmImportToken :: Lens' ImportKeyMaterial ByteString
- ikmEncryptedKeyMaterial :: Lens' ImportKeyMaterial ByteString
- importKeyMaterialResponse :: Int -> ImportKeyMaterialResponse
- data ImportKeyMaterialResponse
- ikmrsResponseStatus :: Lens' ImportKeyMaterialResponse Int
Creating a Request
Creates a value of ImportKeyMaterial
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ikmExpirationModel
- Specifies whether the key material expires. The default isKEY_MATERIAL_EXPIRES
, in which case you must include theValidTo
parameter. When this parameter is set toKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.ikmValidTo
- The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when theExpirationModel
parameter is set toKEY_MATERIAL_DOES_NOT_EXPIRE
. Otherwise it is required.ikmKeyId
- The identifier of the CMK to import the key material into. The CMK'sOrigin
must beEXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID:1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN:arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
ikmImportToken
- The import token that you received in the response to a previousGetParametersForImport
request. It must be from the same response that contained the public key that you used to encrypt the key material.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.ikmEncryptedKeyMaterial
- The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previousGetParametersForImport
request, using the wrapping algorithm that you specified in that request.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.
data ImportKeyMaterial Source #
See: importKeyMaterial
smart constructor.
Request Lenses
ikmExpirationModel :: Lens' ImportKeyMaterial (Maybe ExpirationModelType) Source #
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
, in which case you must include the ValidTo
parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
ikmValidTo :: Lens' ImportKeyMaterial (Maybe UTCTime) Source #
The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel
parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE
. Otherwise it is required.
ikmKeyId :: Lens' ImportKeyMaterial Text Source #
The identifier of the CMK to import the key material into. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
ikmImportToken :: Lens' ImportKeyMaterial ByteString Source #
The import token that you received in the response to a previous GetParametersForImport
request. It must be from the same response that contained the public key that you used to encrypt the key material.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
ikmEncryptedKeyMaterial :: Lens' ImportKeyMaterial ByteString Source #
The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport
request, using the wrapping algorithm that you specified in that request.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
Destructuring the Response
importKeyMaterialResponse Source #
Creates a value of ImportKeyMaterialResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ikmrsResponseStatus
- -- | The response status code.
data ImportKeyMaterialResponse Source #
See: importKeyMaterialResponse
smart constructor.
Response Lenses
ikmrsResponseStatus :: Lens' ImportKeyMaterialResponse Int Source #
- - | The response status code.