| 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.GetKeyRotationStatus
Description
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.
When you enable automatic rotation for customer managed KMS keys, 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.
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 can enable (EnableKeyRotation) and disable automatic rotation
(DisableKeyRotation) of the key material in customer managed KMS keys.
Key material rotation of
Amazon Web Services managed KMS keys
is not configurable. KMS always rotates the key material in Amazon Web
Services managed KMS keys every year. The key rotation status for Amazon
Web Services managed KMS keys is always true.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
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.
- Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
- Pending deletion: While a KMS key is pending deletion, its key
rotation status is
falseand KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns totrue.
Cross-account use: Yes. To perform this operation on a KMS key in a
different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
- DisableKeyRotation
- EnableKeyRotation
Synopsis
- data GetKeyRotationStatus = GetKeyRotationStatus' {}
- newGetKeyRotationStatus :: Text -> GetKeyRotationStatus
- getKeyRotationStatus_keyId :: Lens' GetKeyRotationStatus Text
- data GetKeyRotationStatusResponse = GetKeyRotationStatusResponse' {}
- newGetKeyRotationStatusResponse :: Int -> GetKeyRotationStatusResponse
- getKeyRotationStatusResponse_keyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool)
- getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int
Creating a Request
data GetKeyRotationStatus Source #
See: newGetKeyRotationStatus smart constructor.
Constructors
| GetKeyRotationStatus' | |
Fields
| |
Instances
newGetKeyRotationStatus Source #
Arguments
| :: Text | |
| -> GetKeyRotationStatus |
Create a value of GetKeyRotationStatus 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:
GetKeyRotationStatus, getKeyRotationStatus_keyId - Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
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
getKeyRotationStatus_keyId :: Lens' GetKeyRotationStatus Text Source #
Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
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 GetKeyRotationStatusResponse Source #
See: newGetKeyRotationStatusResponse smart constructor.
Constructors
| GetKeyRotationStatusResponse' | |
Fields
| |
Instances
newGetKeyRotationStatusResponse Source #
Create a value of GetKeyRotationStatusResponse 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:keyRotationEnabled:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_keyRotationEnabled - A Boolean value that specifies whether key rotation is enabled.
$sel:httpStatus:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_httpStatus - The response's http status code.
Response Lenses
getKeyRotationStatusResponse_keyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool) Source #
A Boolean value that specifies whether key rotation is enabled.
getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int Source #
The response's http status code.