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

Contents

Description

Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to 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:

Request Lenses

dkKeyId :: Lens' DisableKey Text Source

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Destructuring the Response

disableKeyResponse :: DisableKeyResponse Source

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