Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KMS.EnableKey

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:EnableKey (key policy)

Related operations: DisableKey

Synopsis

data EnableKey = EnableKey' {
- keyId :: Text
}
newEnableKey :: Text -> EnableKey
enableKey_keyId :: Lens' EnableKey Text
data EnableKeyResponse = EnableKeyResponse' {
}
newEnableKeyResponse :: EnableKeyResponse

Creating a Request

data EnableKey Source #

See: newEnableKey smart constructor.

Constructors

EnableKey'
Fields keyId :: Text Identifies the KMS key to enable. Specify the key ID or key ARN of the KMS key. 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 KMS key, use ListKeys or DescribeKey.

Instances

Instances details

Eq EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods (==) :: EnableKey -> EnableKey -> Bool # (/=) :: EnableKey -> EnableKey -> Bool #
Read EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods readsPrec :: Int -> ReadS EnableKey # readList :: ReadS [EnableKey] # readPrec :: ReadPrec EnableKey # readListPrec :: ReadPrec [EnableKey] #
Show EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods showsPrec :: Int -> EnableKey -> ShowS # show :: EnableKey -> String # showList :: [EnableKey] -> ShowS #
Generic EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Associated Types type Rep EnableKey :: Type -> Type # Methods from :: EnableKey -> Rep EnableKey x # to :: Rep EnableKey x -> EnableKey #
NFData EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods rnf :: EnableKey -> () #
Hashable EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods hashWithSalt :: Int -> EnableKey -> Int # hash :: EnableKey -> Int #
ToJSON EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods toJSON :: EnableKey -> Value # toEncoding :: EnableKey -> Encoding # toJSONList :: [EnableKey] -> Value # toEncodingList :: [EnableKey] -> Encoding #
AWSRequest EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Associated Types type AWSResponse EnableKey # Methods request :: EnableKey -> Request EnableKey # response :: MonadResource m => Logger -> Service -> Proxy EnableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKey))) #
ToHeaders EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods toHeaders :: EnableKey -> [Header] #
ToPath EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods toPath :: EnableKey -> ByteString #
ToQuery EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods toQuery :: EnableKey -> QueryString #
type Rep EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey type Rep EnableKey = D1 ('MetaData "EnableKey" "Amazonka.KMS.EnableKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "EnableKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse EnableKey Source #
Instance details Defined in Amazonka.KMS.EnableKey type AWSResponse EnableKey = EnableKeyResponse

newEnableKey Source #

Arguments

:: Text	`$sel:keyId:EnableKey'`
-> EnableKey

Create a value of EnableKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyId:EnableKey', enableKey_keyId - Identifies the KMS key to enable.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Request Lenses

enableKey_keyId :: Lens' EnableKey Text Source #

Identifies the KMS key to enable.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Destructuring the Response

data EnableKeyResponse Source #

See: newEnableKeyResponse smart constructor.

Constructors

EnableKeyResponse'

Instances

Instances details

Eq EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods (==) :: EnableKeyResponse -> EnableKeyResponse -> Bool # (/=) :: EnableKeyResponse -> EnableKeyResponse -> Bool #
Read EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods readsPrec :: Int -> ReadS EnableKeyResponse # readList :: ReadS [EnableKeyResponse] # readPrec :: ReadPrec EnableKeyResponse # readListPrec :: ReadPrec [EnableKeyResponse] #
Show EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods showsPrec :: Int -> EnableKeyResponse -> ShowS # show :: EnableKeyResponse -> String # showList :: [EnableKeyResponse] -> ShowS #
Generic EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey Associated Types type Rep EnableKeyResponse :: Type -> Type # Methods from :: EnableKeyResponse -> Rep EnableKeyResponse x # to :: Rep EnableKeyResponse x -> EnableKeyResponse #
NFData EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey Methods rnf :: EnableKeyResponse -> () #
type Rep EnableKeyResponse Source #
Instance details Defined in Amazonka.KMS.EnableKey type Rep EnableKeyResponse = D1 ('MetaData "EnableKeyResponse" "Amazonka.KMS.EnableKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "EnableKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableKeyResponse :: EnableKeyResponse Source #

Create a value of EnableKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.