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.GetKeyRotationStatus
Description
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified 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 key rotation status for these
KMS keys is always false
.
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.
- 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.
- Pending deletion: While a KMS key is pending deletion, its key
rotation status is
false
and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status is restored.
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:
$sel:keyId: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.