Struct aws_sdk_secretsmanager::client::fluent_builders::CancelRotateSecret

pub struct CancelRotateSecret { /* private fields */ }

Fluent builder constructing a request to CancelRotateSecret.

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.

Implementations

impl CancelRotateSecret

pub async fn customize(
    self
) -> Result<CustomizableOperation<CancelRotateSecret, AwsResponseRetryClassifier>, SdkError<CancelRotateSecretError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CancelRotateSecretOutput, SdkError<CancelRotateSecretError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn secret_id(self, input: impl Into<String>) -> Self

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.

pub fn set_secret_id(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for CancelRotateSecret

fn clone(&self) -> CancelRotateSecret

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CancelRotateSecret

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.