Copyright | (c) 2013-2015 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 |
Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
See: AWS API Reference for CreateKey.
- createKey :: CreateKey
- data CreateKey
- ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType)
- ckPolicy :: Lens' CreateKey (Maybe Text)
- ckDescription :: Lens' CreateKey (Maybe Text)
- createKeyResponse :: Int -> CreateKeyResponse
- data CreateKeyResponse
- ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata)
- ckrsResponseStatus :: Lens' CreateKeyResponse Int
Creating a Request
Creates a value of CreateKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
See: createKey
smart constructor.
Request Lenses
ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType) Source
Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.
ckPolicy :: Lens' CreateKey (Maybe Text) Source
Policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).
ckDescription :: Lens' CreateKey (Maybe Text) Source
Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.
Destructuring the Response
Creates a value of CreateKeyResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateKeyResponse Source
See: createKeyResponse
smart constructor.
Response Lenses
ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata) Source
Metadata associated with the key.
ckrsResponseStatus :: Lens' CreateKeyResponse Int Source
The response status code.