Network.AWS.KMS.CreateKey

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.

Creating a Request

createKey :: CreateKey

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:

• ckKeyUsage
• ckPolicy
• ckDescription

data CreateKey

See: createKey smart constructor.

Instances

Eq CreateKey

Data CreateKey

Read CreateKey

Show CreateKey

Generic CreateKey

ToJSON CreateKey

AWSRequest CreateKey

ToPath CreateKey

ToHeaders CreateKey

ToQuery CreateKey

Typeable * CreateKey

type Rep CreateKey

type Sv CreateKey = KMS

type Rs CreateKey = CreateKeyResponse

Request Lenses

ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType)

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)

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

ckDescription :: Lens' CreateKey (Maybe Text)

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

createKeyResponse

Arguments

:: Int

ckrsStatus

-> CreateKeyResponse

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:

• ckrsKeyMetadata
• ckrsStatus

data CreateKeyResponse

See: createKeyResponse smart constructor.

Instances

Eq CreateKeyResponse

Data CreateKeyResponse

Read CreateKeyResponse

Show CreateKeyResponse

Generic CreateKeyResponse

Typeable * CreateKeyResponse

type Rep CreateKeyResponse

Response Lenses

ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata)

Metadata associated with the key.

ckrsStatus :: Lens' CreateKeyResponse Int

The response status code.