Network.AWS.KMS.CreateKey

Creates a customer master key (CMK) in the caller's AWS account.

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

• The GenerateDataKey operation
• AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide

You cannot use this operation to create a CMK in a different AWS account.

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:

• ckOrigin - The source of the CMK's key material. The default is AWS_KMS , which means AWS KMS creates the key material. When this parameter is set to EXTERNAL , the request creates a CMK without key material so that you can import key material 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 . The CMK's Origin is immutable and is set when the CMK is created.
• ckKeyUsage - The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.
• ckBypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS 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 CMK. The default value is false.
• ckPolicy - The key policy to attach to the CMK. 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 CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS 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 AWS KMS. When you create a new AWS 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide . If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide . The key policy size limit is 32 kilobytes (32768 bytes).
• ckDescription - A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.
• ckTags - One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource .

data CreateKey

See: createKey smart constructor.

Instances

Eq CreateKey

Methods

(==) :: CreateKey -> CreateKey -> Bool

(/=) :: CreateKey -> CreateKey -> Bool

Data CreateKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateKey -> c CreateKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateKey

toConstr :: CreateKey -> Constr

dataTypeOf :: CreateKey -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateKey)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateKey)

gmapT :: (forall b. Data b => b -> b) -> CreateKey -> CreateKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateKey -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateKey -> m CreateKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateKey -> m CreateKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateKey -> m CreateKey

Read CreateKey

Methods

readsPrec :: Int -> ReadS CreateKey

readList :: ReadS [CreateKey]

readPrec :: ReadPrec CreateKey

readListPrec :: ReadPrec [CreateKey]

Show CreateKey

Methods

showsPrec :: Int -> CreateKey -> ShowS

show :: CreateKey -> String

showList :: [CreateKey] -> ShowS

Generic CreateKey

Associated Types

type Rep CreateKey :: * -> *

Methods

from :: CreateKey -> Rep CreateKey x

to :: Rep CreateKey x -> CreateKey

Hashable CreateKey

Methods

hashWithSalt :: Int -> CreateKey -> Int

hash :: CreateKey -> Int

ToJSON CreateKey

Methods

toJSON :: CreateKey -> Value

toEncoding :: CreateKey -> Encoding

toJSONList :: [CreateKey] -> Value

toEncodingList :: [CreateKey] -> Encoding

NFData CreateKey

Methods

rnf :: CreateKey -> ()

AWSRequest CreateKey

Associated Types

type Rs CreateKey :: *

Methods

request :: CreateKey -> Request CreateKey

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateKey -> ClientResponse -> m (Response CreateKey)

ToHeaders CreateKey

Methods

toHeaders :: CreateKey -> [Header]

ToPath CreateKey

Methods

toPath :: CreateKey -> ByteString

ToQuery CreateKey

Methods

toQuery :: CreateKey -> QueryString

type Rep CreateKey

type Rep CreateKey = D1 * (MetaData "CreateKey" "Network.AWS.KMS.CreateKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "CreateKey'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ckOrigin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OriginType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ckKeyUsage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe KeyUsageType))) (S1 * (MetaSel (Just Symbol "_ckBypassPolicyLockoutSafetyCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ckPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ckDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ckTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag])))))))

type Rs CreateKey

type Rs CreateKey = CreateKeyResponse

Request Lenses

ckOrigin :: Lens' CreateKey (Maybe OriginType)

The source of the CMK's key material. The default is AWS_KMS , which means AWS KMS creates the key material. When this parameter is set to EXTERNAL , the request creates a CMK without key material so that you can import key material 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 . The CMK's Origin is immutable and is set when the CMK is created.

ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType)

The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.

ckBypassPolicyLockoutSafetyCheck :: Lens' CreateKey (Maybe Bool)

A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS 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 CMK. The default value is false.

ckPolicy :: Lens' CreateKey (Maybe Text)

The key policy to attach to the CMK. 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 CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS 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 AWS KMS. When you create a new AWS 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide . If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide . The key policy size limit is 32 kilobytes (32768 bytes).

ckDescription :: Lens' CreateKey (Maybe Text)

A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.

ckTags :: Lens' CreateKey [Tag]

One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource .

Destructuring the Response

createKeyResponse

Arguments

:: Int

ckrsResponseStatus

-> 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 - Metadata associated with the CMK.
• ckrsResponseStatus - -- | The response status code.

data CreateKeyResponse

See: createKeyResponse smart constructor.

Instances

Eq CreateKeyResponse

Methods

(==) :: CreateKeyResponse -> CreateKeyResponse -> Bool

(/=) :: CreateKeyResponse -> CreateKeyResponse -> Bool

Data CreateKeyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateKeyResponse -> c CreateKeyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateKeyResponse

toConstr :: CreateKeyResponse -> Constr

dataTypeOf :: CreateKeyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateKeyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateKeyResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateKeyResponse -> CreateKeyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateKeyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateKeyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateKeyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateKeyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateKeyResponse -> m CreateKeyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateKeyResponse -> m CreateKeyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateKeyResponse -> m CreateKeyResponse

Read CreateKeyResponse

Methods

readsPrec :: Int -> ReadS CreateKeyResponse

readList :: ReadS [CreateKeyResponse]

readPrec :: ReadPrec CreateKeyResponse

readListPrec :: ReadPrec [CreateKeyResponse]

Show CreateKeyResponse

Methods

showsPrec :: Int -> CreateKeyResponse -> ShowS

show :: CreateKeyResponse -> String

showList :: [CreateKeyResponse] -> ShowS

Generic CreateKeyResponse

Associated Types

type Rep CreateKeyResponse :: * -> *

Methods

from :: CreateKeyResponse -> Rep CreateKeyResponse x

to :: Rep CreateKeyResponse x -> CreateKeyResponse

NFData CreateKeyResponse

Methods

rnf :: CreateKeyResponse -> ()

type Rep CreateKeyResponse

type Rep CreateKeyResponse = D1 * (MetaData "CreateKeyResponse" "Network.AWS.KMS.CreateKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "CreateKeyResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ckrsKeyMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe KeyMetadata))) (S1 * (MetaSel (Just Symbol "_ckrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata)

Metadata associated with the CMK.

ckrsResponseStatus :: Lens' CreateKeyResponse Int

• - | The response status code.