amazonka-kms-1.4.5: Amazon Key Management Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KMS.CreateKey

Contents

Description

Creates a customer master key (CMK).

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:

Synopsis

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 likelihood 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 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 specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria: * It must allow the principal making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
  • ckDescription - A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.

data CreateKey #

See: createKey smart constructor.

Instances

Eq CreateKey # 
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 # 
Show CreateKey # 
Generic CreateKey # 

Associated Types

type Rep CreateKey :: * -> * #

Hashable CreateKey # 
ToJSON CreateKey # 
NFData CreateKey # 

Methods

rnf :: CreateKey -> () #

AWSRequest CreateKey # 
ToQuery CreateKey # 
ToPath CreateKey # 
ToHeaders CreateKey # 

Methods

toHeaders :: CreateKey -> [Header] #

type Rep CreateKey # 
type Rep CreateKey = D1 (MetaData "CreateKey" "Network.AWS.KMS.CreateKey" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" 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)))))))
type Rs CreateKey # 

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 likelihood 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 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 specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria: * It must allow the principal making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . If you do not specify a 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 policy size limit is 32 KiB (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.

Destructuring the Response

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:

data CreateKeyResponse #

See: createKeyResponse smart constructor.

Instances

Eq CreateKeyResponse # 
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 # 
Show CreateKeyResponse # 
Generic CreateKeyResponse # 
NFData CreateKeyResponse # 

Methods

rnf :: CreateKeyResponse -> () #

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

Response Lenses

ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata) #

Metadata associated with the CMK.

ckrsResponseStatus :: Lens' CreateKeyResponse Int #

  • - | The response status code.