Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KMS.EnableKeyRotation

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.

Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC 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.

You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).

New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.

Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys 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

data EnableKeyRotation = EnableKeyRotation' {
- keyId :: Text
}
newEnableKeyRotation :: Text -> EnableKeyRotation
enableKeyRotation_keyId :: Lens' EnableKeyRotation Text
data EnableKeyRotationResponse = EnableKeyRotationResponse' {
}
newEnableKeyRotationResponse :: EnableKeyRotationResponse

Creating a Request

data EnableKeyRotation Source #

See: newEnableKeyRotation smart constructor.

Constructors

EnableKeyRotation'

Fields

keyId :: Text
Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC 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

ToJSON EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods toJSON :: EnableKeyRotation -> Value # toEncoding :: EnableKeyRotation -> Encoding # toJSONList :: [EnableKeyRotation] -> Value # toEncodingList :: [EnableKeyRotation] -> Encoding #
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 #
AWSRequest EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Associated Types type AWSResponse EnableKeyRotation # Methods request :: (Service -> Service) -> EnableKeyRotation -> Request EnableKeyRotation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableKeyRotation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKeyRotation))) #
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 #
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 #
NFData EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods rnf :: EnableKeyRotation -> () #
Eq EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods (==) :: EnableKeyRotation -> EnableKeyRotation -> Bool # (/=) :: EnableKeyRotation -> EnableKeyRotation -> Bool #
Hashable EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods hashWithSalt :: Int -> EnableKeyRotation -> Int # hash :: EnableKeyRotation -> Int #
type AWSResponse EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation type AWSResponse EnableKeyRotation = EnableKeyRotationResponse
type Rep EnableKeyRotation Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation type Rep EnableKeyRotation = D1 ('MetaData "EnableKeyRotation" "Amazonka.KMS.EnableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EnableKeyRotation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEnableKeyRotation Source #

Arguments

:: Text	`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:

EnableKeyRotation, enableKeyRotation_keyId - Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC 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 encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC 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

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 #
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 #
NFData EnableKeyRotationResponse Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods rnf :: EnableKeyRotationResponse -> () #
Eq EnableKeyRotationResponse Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation Methods (==) :: EnableKeyRotationResponse -> EnableKeyRotationResponse -> Bool # (/=) :: EnableKeyRotationResponse -> EnableKeyRotationResponse -> Bool #
type Rep EnableKeyRotationResponse Source #
Instance details Defined in Amazonka.KMS.EnableKeyRotation type Rep EnableKeyRotationResponse = D1 ('MetaData "EnableKeyRotationResponse" "Amazonka.KMS.EnableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" '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.