| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.KMS.GetKeyRotationStatus
Description
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
Synopsis
- getKeyRotationStatus :: Text -> GetKeyRotationStatus
- data GetKeyRotationStatus
- gkrsKeyId :: Lens' GetKeyRotationStatus Text
- getKeyRotationStatusResponse :: Int -> GetKeyRotationStatusResponse
- data GetKeyRotationStatusResponse
- gkrsrsKeyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool)
- gkrsrsResponseStatus :: Lens' GetKeyRotationStatusResponse Int
Creating a Request
Arguments
| :: Text | |
| -> GetKeyRotationStatus |
Creates a value of GetKeyRotationStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gkrsKeyId- A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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-1234567890abTo get the key ID and key ARN for a CMK, useListKeysorDescribeKey.
data GetKeyRotationStatus Source #
See: getKeyRotationStatus smart constructor.
Instances
Request Lenses
gkrsKeyId :: Lens' GetKeyRotationStatus Text Source #
A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey .
Destructuring the Response
getKeyRotationStatusResponse Source #
Arguments
| :: Int | |
| -> GetKeyRotationStatusResponse |
Creates a value of GetKeyRotationStatusResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gkrsrsKeyRotationEnabled- A Boolean value that specifies whether key rotation is enabled.gkrsrsResponseStatus- -- | The response status code.
data GetKeyRotationStatusResponse Source #
See: getKeyRotationStatusResponse smart constructor.
Instances
Response Lenses
gkrsrsKeyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool) Source #
A Boolean value that specifies whether key rotation is enabled.
gkrsrsResponseStatus :: Lens' GetKeyRotationStatusResponse Int Source #
- - | The response status code.