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

Amazonka.KMS.EnableKeyRotation

Description

Enables automatic rotation of the key material for the specified symmetric KMS key.

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

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:EnableKeyRotation (key policy)

Related operations:

  • DisableKeyRotation
  • GetKeyRotationStatus
Synopsis

Creating a Request

data EnableKeyRotation Source #

See: newEnableKeyRotation smart constructor.

Constructors

EnableKeyRotation' 

Fields

  • keyId :: Text

    Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

    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 EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

(==) :: EnableKeyRotation -> EnableKeyRotation -> Bool #

(/=) :: EnableKeyRotation -> EnableKeyRotation -> Bool #

Read EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

readsPrec :: Int -> ReadS EnableKeyRotation #

readList :: ReadS [EnableKeyRotation] #

readPrec :: ReadPrec EnableKeyRotation #

readListPrec :: ReadPrec [EnableKeyRotation] #

Show EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

showsPrec :: Int -> EnableKeyRotation -> ShowS #

show :: EnableKeyRotation -> String #

showList :: [EnableKeyRotation] -> ShowS #

Generic EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type Rep EnableKeyRotation :: Type -> Type #

Methods

from :: EnableKeyRotation -> Rep EnableKeyRotation x #

to :: Rep EnableKeyRotation x -> EnableKeyRotation #

NFData EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

rnf :: EnableKeyRotation -> () #

Hashable EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

hashWithSalt :: Int -> EnableKeyRotation -> Int #

hash :: EnableKeyRotation -> Int #

ToJSON EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toJSON :: EnableKeyRotation -> Value #

toEncoding :: EnableKeyRotation -> Encoding #

toJSONList :: [EnableKeyRotation] -> Value #

toEncodingList :: [EnableKeyRotation] -> Encoding #

AWSRequest EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type AWSResponse EnableKeyRotation #

Methods

request :: EnableKeyRotation -> Request EnableKeyRotation #

response :: MonadResource m => Logger -> Service -> Proxy EnableKeyRotation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKeyRotation))) #

ToHeaders EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toHeaders :: EnableKeyRotation -> [Header] #

ToPath EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toPath :: EnableKeyRotation -> ByteString #

ToQuery EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toQuery :: EnableKeyRotation -> QueryString #

type Rep EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

type Rep EnableKeyRotation = D1 ('MetaData "EnableKeyRotation" "Amazonka.KMS.EnableKeyRotation" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "EnableKeyRotation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse EnableKeyRotation Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

type AWSResponse EnableKeyRotation = EnableKeyRotationResponse

newEnableKeyRotation Source #

Arguments

:: Text

$sel:keyId:EnableKeyRotation'

-> EnableKeyRotation 

Create a value of EnableKeyRotation 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:EnableKeyRotation', enableKeyRotation_keyId - Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

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

enableKeyRotation_keyId :: Lens' EnableKeyRotation Text Source #

Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

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 EnableKeyRotationResponse Source #

See: newEnableKeyRotationResponse smart constructor.

Constructors

EnableKeyRotationResponse' 

Instances

Instances details
Eq EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

(==) :: EnableKeyRotationResponse -> EnableKeyRotationResponse -> Bool #

(/=) :: EnableKeyRotationResponse -> EnableKeyRotationResponse -> Bool #

Read EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

readsPrec :: Int -> ReadS EnableKeyRotationResponse #

readList :: ReadS [EnableKeyRotationResponse] #

readPrec :: ReadPrec EnableKeyRotationResponse #

readListPrec :: ReadPrec [EnableKeyRotationResponse] #

Show EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

showsPrec :: Int -> EnableKeyRotationResponse -> ShowS #

show :: EnableKeyRotationResponse -> String #

showList :: [EnableKeyRotationResponse] -> ShowS #

Generic EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type Rep EnableKeyRotationResponse :: Type -> Type #

Methods

from :: EnableKeyRotationResponse -> Rep EnableKeyRotationResponse x #

to :: Rep EnableKeyRotationResponse x -> EnableKeyRotationResponse #

NFData EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

Methods

rnf :: EnableKeyRotationResponse -> () #

type Rep EnableKeyRotationResponse Source # 
Instance details

Defined in Amazonka.KMS.EnableKeyRotation

type Rep EnableKeyRotationResponse = D1 ('MetaData "EnableKeyRotationResponse" "Amazonka.KMS.EnableKeyRotation" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "EnableKeyRotationResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableKeyRotationResponse :: EnableKeyRotationResponse Source #

Create a value of EnableKeyRotationResponse with all optional fields omitted.

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