Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has two primary use cases:
- You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
- To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey
or GenerateDataKeyWithoutPlaintext
operation. Data keys don't need to be encrypted again by calling Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey
operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
Synopsis
- encrypt :: Text -> ByteString -> Encrypt
- data Encrypt
- eEncryptionContext :: Lens' Encrypt (HashMap Text Text)
- eGrantTokens :: Lens' Encrypt [Text]
- eKeyId :: Lens' Encrypt Text
- ePlaintext :: Lens' Encrypt ByteString
- encryptResponse :: Int -> EncryptResponse
- data EncryptResponse
- ersKeyId :: Lens' EncryptResponse (Maybe Text)
- ersCiphertextBlob :: Lens' EncryptResponse (Maybe ByteString)
- ersResponseStatus :: Lens' EncryptResponse Int
Creating a Request
Creates a value of Encrypt
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eEncryptionContext
- Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to theDecrypt
API or decryption will fail. For more information, see Encryption Context .eGrantTokens
- A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .eKeyId
- A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: * Key ID:1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN: @arn:aws:kms:us-east-2:111122223333:key1234abcd-12ab-34cd-56ef-1234567890ab* Alias name:
aliasExampleAlias* Alias ARN:
arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ To get the key ID and key ARN for a CMK, useListKeys
orDescribeKey
. To get the alias name and alias ARN, useListAliases
.ePlaintext
- Data to be encrypted.-- 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.
See: encrypt
smart constructor.
Instances
Request Lenses
eEncryptionContext :: Lens' Encrypt (HashMap Text Text) Source #
Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context .
eGrantTokens :: Lens' Encrypt [Text] Source #
A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .
eKeyId :: Lens' Encrypt Text Source #
A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN: @arn:aws:kms:us-east-2:111122223333:key1234abcd-12ab-34cd-56ef-1234567890ab * Alias name:
aliasExampleAlias * Alias ARN:
arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ To get the key ID and key ARN for a CMK, use ListKeys
or DescribeKey
. To get the alias name and alias ARN, use ListAliases
.
ePlaintext :: Lens' Encrypt ByteString Source #
Data to be encrypted.-- 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
Creates a value of EncryptResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ersKeyId
- The ID of the key used during encryption.ersCiphertextBlob
- The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.-- 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.ersResponseStatus
- -- | The response status code.
data EncryptResponse Source #
See: encryptResponse
smart constructor.
Instances
Response Lenses
ersCiphertextBlob :: Lens' EncryptResponse (Maybe ByteString) Source #
The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.-- 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.
ersResponseStatus :: Lens' EncryptResponse Int Source #
- - | The response status code.