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 |
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state. You might need to remove the staging
label AWSPENDING
from the partially created version. You also need to
determine whether to roll back to the previous version of the secret by
moving the staging label AWSCURRENT
to the version that has
AWSPENDING
. To determine which version has a specific staging label,
call ListSecretVersionIds. Then use UpdateSecretVersionStage to change
staging labels. For more information, see
How rotation works.
To turn on automatic rotation again, call RotateSecret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CancelRotateSecret
. For more
information, see
IAM policy actions for Secrets Manager
and
Authentication and access control in Secrets Manager.
Synopsis
- data CancelRotateSecret = CancelRotateSecret' {}
- newCancelRotateSecret :: Text -> CancelRotateSecret
- cancelRotateSecret_secretId :: Lens' CancelRotateSecret Text
- data CancelRotateSecretResponse = CancelRotateSecretResponse' {}
- newCancelRotateSecretResponse :: Int -> CancelRotateSecretResponse
- cancelRotateSecretResponse_arn :: Lens' CancelRotateSecretResponse (Maybe Text)
- cancelRotateSecretResponse_name :: Lens' CancelRotateSecretResponse (Maybe Text)
- cancelRotateSecretResponse_versionId :: Lens' CancelRotateSecretResponse (Maybe Text)
- cancelRotateSecretResponse_httpStatus :: Lens' CancelRotateSecretResponse Int
Creating a Request
data CancelRotateSecret Source #
See: newCancelRotateSecret
smart constructor.
CancelRotateSecret' | |
|
Instances
newCancelRotateSecret Source #
Create a value of CancelRotateSecret
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:secretId:CancelRotateSecret'
, cancelRotateSecret_secretId
- The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Request Lenses
cancelRotateSecret_secretId :: Lens' CancelRotateSecret Text Source #
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Destructuring the Response
data CancelRotateSecretResponse Source #
See: newCancelRotateSecretResponse
smart constructor.
CancelRotateSecretResponse' | |
|
Instances
newCancelRotateSecretResponse Source #
Create a value of CancelRotateSecretResponse
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:
CancelRotateSecretResponse
, cancelRotateSecretResponse_arn
- The ARN of the secret.
CancelRotateSecretResponse
, cancelRotateSecretResponse_name
- The name of the secret.
CancelRotateSecretResponse
, cancelRotateSecretResponse_versionId
- The unique identifier of the version of the secret created during the
rotation. This version might not be complete, and should be evaluated
for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete
it. Failing to clean up a cancelled rotation can block you from starting
future rotations.
$sel:httpStatus:CancelRotateSecretResponse'
, cancelRotateSecretResponse_httpStatus
- The response's http status code.
Response Lenses
cancelRotateSecretResponse_arn :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The ARN of the secret.
cancelRotateSecretResponse_name :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The name of the secret.
cancelRotateSecretResponse_versionId :: Lens' CancelRotateSecretResponse (Maybe Text) Source #
The unique identifier of the version of the secret created during the
rotation. This version might not be complete, and should be evaluated
for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete
it. Failing to clean up a cancelled rotation can block you from starting
future rotations.
cancelRotateSecretResponse_httpStatus :: Lens' CancelRotateSecretResponse Int Source #
The response's http status code.