1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_secret_version_stage::_update_secret_version_stage_output::UpdateSecretVersionStageOutputBuilder;
pub use crate::operation::update_secret_version_stage::_update_secret_version_stage_input::UpdateSecretVersionStageInputBuilder;
impl UpdateSecretVersionStageInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.update_secret_version_stage();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `UpdateSecretVersionStage`.
///
/// <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>.</p>
/// <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added to the existing list of staging labels for the version.</p>
/// <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this call.</p><note>
/// <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// </note>
/// <p>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.</p>
/// <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
/// <p><b>Required permissions: </b> <code>secretsmanager:UpdateSecretVersionStage</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions"> IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control in Secrets Manager</a>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateSecretVersionStageFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_secret_version_stage::builders::UpdateSecretVersionStageInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageOutput,
crate::operation::update_secret_version_stage::UpdateSecretVersionStageError,
> for UpdateSecretVersionStageFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageOutput,
crate::operation::update_secret_version_stage::UpdateSecretVersionStageError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl UpdateSecretVersionStageFluentBuilder {
/// Creates a new `UpdateSecretVersionStage`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the UpdateSecretVersionStage as a reference.
pub fn as_input(&self) -> &crate::operation::update_secret_version_stage::builders::UpdateSecretVersionStageInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::update_secret_version_stage::UpdateSecretVersionStage::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::update_secret_version_stage::UpdateSecretVersionStage::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::update_secret_version_stage::UpdateSecretVersionStageOutput,
crate::operation::update_secret_version_stage::UpdateSecretVersionStageError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn secret_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.secret_id(input.into());
self
}
/// <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn set_secret_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_secret_id(input);
self
}
/// <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn get_secret_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_secret_id()
}
/// <p>The staging label to add to this version.</p>
pub fn version_stage(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.version_stage(input.into());
self
}
/// <p>The staging label to add to this version.</p>
pub fn set_version_stage(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_version_stage(input);
self
}
/// <p>The staging label to add to this version.</p>
pub fn get_version_stage(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_version_stage()
}
/// <p>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.</p>
pub fn remove_from_version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.remove_from_version_id(input.into());
self
}
/// <p>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.</p>
pub fn set_remove_from_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_remove_from_version_id(input);
self
}
/// <p>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.</p>
pub fn get_remove_from_version_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_remove_from_version_id()
}
/// <p>The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.</p>
/// <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter.</p>
pub fn move_to_version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.move_to_version_id(input.into());
self
}
/// <p>The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.</p>
/// <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter.</p>
pub fn set_move_to_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_move_to_version_id(input);
self
}
/// <p>The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.</p>
/// <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter.</p>
pub fn get_move_to_version_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_move_to_version_id()
}
}