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 |
Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.
To re-enable scheduled rotation, call RotateSecret
with AutomaticallyRotateAfterDays
set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.
To successfully start a rotation, the staging label AWSPENDING
must be in one of the following states:
- Not be attached to any version at all
- Attached to the same version as the staging label
AWSCURRENT
If the staging label AWSPENDING
is attached to a different version than the version with AWSCURRENT
then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:CancelRotateSecret
Related operations
- To configure rotation for a secret or to manually trigger a rotation, use
RotateSecret
. - To get the rotation configuration details for a secret, use
DescribeSecret
. - To list all of the currently available secrets, use
ListSecrets
. - To list all of the versions currently associated with a secret, use
ListSecretVersionIds
.
Synopsis
- cancelRotateSecret :: Text -> CancelRotateSecret
- data CancelRotateSecret
- crsSecretId :: Lens' CancelRotateSecret Text
- cancelRotateSecretResponse :: Int -> CancelRotateSecretResponse
- data CancelRotateSecretResponse
- crsrsVersionId :: Lens' CancelRotateSecretResponse (Maybe Text)
- crsrsARN :: Lens' CancelRotateSecretResponse (Maybe Text)
- crsrsName :: Lens' CancelRotateSecretResponse (Maybe Text)
- crsrsResponseStatus :: Lens' CancelRotateSecretResponse Int
Creating a Request
Creates a value of CancelRotateSecret
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crsSecretId
- Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
data CancelRotateSecret Source #
See: cancelRotateSecret
smart constructor.
Instances
Request Lenses
crsSecretId :: Lens' CancelRotateSecret Text Source #
Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
Destructuring the Response
cancelRotateSecretResponse Source #
Creates a value of CancelRotateSecretResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crsrsVersionId
- The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove theVersionStage
valueAWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.crsrsARN
- The ARN of the secret for which rotation was canceled.crsrsName
- The friendly name of the secret for which rotation was canceled.crsrsResponseStatus
- -- | The response status code.
data CancelRotateSecretResponse Source #
See: cancelRotateSecretResponse
smart constructor.
Instances
Response Lenses
crsrsVersionId :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
crsrsARN :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The ARN of the secret for which rotation was canceled.
crsrsName :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The friendly name of the secret for which rotation was canceled.
crsrsResponseStatus :: Lens' CancelRotateSecretResponse Int Source #
- - | The response status code.