Struct UpdateSecretVersionStageFluentBuilder

pub struct UpdateSecretVersionStageFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateSecretVersionStage.

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

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:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Implementations

impl UpdateSecretVersionStageFluentBuilder

pub fn as_input(&self) -> &UpdateSecretVersionStageInputBuilder

Access the UpdateSecretVersionStage as a reference.

pub async fn send( self, ) -> Result<UpdateSecretVersionStageOutput, SdkError<UpdateSecretVersionStageError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<UpdateSecretVersionStageOutput, UpdateSecretVersionStageError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The ARN or the name of the secret with the version and staging labelsto modify.

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 the name of the secret with the version and staging labelsto modify.

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 get_secret_id(&self) -> &Option<String>

The ARN or the name of the secret with the version and staging labelsto modify.

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 version_stage(self, input: impl Into<String>) -> Self

The staging label to add to this version.

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

The staging label to add to this version.

pub fn get_version_stage(&self) -> &Option<String>

The staging label to add to this version.

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

The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

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

The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

pub fn get_remove_from_version_id(&self) -> &Option<String>

The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

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

The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

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

The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

pub fn get_move_to_version_id(&self) -> &Option<String>

The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

Trait Implementations

impl Clone for UpdateSecretVersionStageFluentBuilder

fn clone(&self) -> UpdateSecretVersionStageFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateSecretVersionStageFluentBuilder

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

Formats the value using the given formatter.