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

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

Network.AWS.KMS.EnableKey

Contents

Description

Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

Synopsis

Creating a Request

enableKey Source #

Arguments

:: Text

ekKeyId

-> EnableKey 

Creates a value of EnableKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ekKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

data EnableKey Source #

See: enableKey smart constructor.

Instances

Eq EnableKey Source # 
Data EnableKey Source # 

Methods

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

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

toConstr :: EnableKey -> Constr #

dataTypeOf :: EnableKey -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> EnableKey -> EnableKey #

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

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

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

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

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

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

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

Read EnableKey Source # 
Show EnableKey Source # 
Generic EnableKey Source # 

Associated Types

type Rep EnableKey :: * -> * #

Hashable EnableKey Source # 
ToJSON EnableKey Source # 
NFData EnableKey Source # 

Methods

rnf :: EnableKey -> () #

AWSRequest EnableKey Source # 
ToHeaders EnableKey Source # 

Methods

toHeaders :: EnableKey -> [Header] #

ToPath EnableKey Source # 
ToQuery EnableKey Source # 
type Rep EnableKey Source # 
type Rep EnableKey = D1 * (MetaData "EnableKey" "Network.AWS.KMS.EnableKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" True) (C1 * (MetaCons "EnableKey'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ekKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs EnableKey Source # 

Request Lenses

ekKeyId :: Lens' EnableKey Text Source #

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

Destructuring the Response

enableKeyResponse :: EnableKeyResponse Source #

Creates a value of EnableKeyResponse with the minimum fields required to make a request.

data EnableKeyResponse Source #

See: enableKeyResponse smart constructor.

Instances

Eq EnableKeyResponse Source # 
Data EnableKeyResponse Source # 

Methods

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

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

toConstr :: EnableKeyResponse -> Constr #

dataTypeOf :: EnableKeyResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> EnableKeyResponse -> EnableKeyResponse #

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

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

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

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

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

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

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

Read EnableKeyResponse Source # 
Show EnableKeyResponse Source # 
Generic EnableKeyResponse Source # 
NFData EnableKeyResponse Source # 

Methods

rnf :: EnableKeyResponse -> () #

type Rep EnableKeyResponse Source # 
type Rep EnableKeyResponse = D1 * (MetaData "EnableKeyResponse" "Network.AWS.KMS.EnableKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "EnableKeyResponse'" PrefixI False) (U1 *))