amazonka-kms-1.6.1: 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.DisableKey

Contents

Description

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

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

Synopsis

Creating a Request

disableKey Source #

Arguments

:: Text

dkKeyId

-> DisableKey 

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

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

  • dkKeyId - 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 DisableKey Source #

See: disableKey smart constructor.

Instances
Eq DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Data DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Methods

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

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

toConstr :: DisableKey -> Constr #

dataTypeOf :: DisableKey -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Show DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Generic DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Associated Types

type Rep DisableKey :: Type -> Type #

Hashable DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

ToJSON DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

AWSRequest DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Associated Types

type Rs DisableKey :: Type #

ToHeaders DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Methods

toHeaders :: DisableKey -> [Header] #

ToPath DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

ToQuery DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

NFData DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Methods

rnf :: DisableKey -> () #

type Rep DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

type Rep DisableKey = D1 (MetaData "DisableKey" "Network.AWS.KMS.DisableKey" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" True) (C1 (MetaCons "DisableKey'" PrefixI True) (S1 (MetaSel (Just "_dkKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DisableKey Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Request Lenses

dkKeyId :: Lens' DisableKey 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

disableKeyResponse :: DisableKeyResponse Source #

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

data DisableKeyResponse Source #

See: disableKeyResponse smart constructor.

Instances
Eq DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Data DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Methods

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

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

toConstr :: DisableKeyResponse -> Constr #

dataTypeOf :: DisableKeyResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Show DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Generic DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Associated Types

type Rep DisableKeyResponse :: Type -> Type #

NFData DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

Methods

rnf :: DisableKeyResponse -> () #

type Rep DisableKeyResponse Source # 
Instance details

Defined in Network.AWS.KMS.DisableKey

type Rep DisableKeyResponse = D1 (MetaData "DisableKeyResponse" "Network.AWS.KMS.DisableKey" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "DisableKeyResponse'" PrefixI False) (U1 :: Type -> Type))