aws_sdk_secretsmanager/operation/cancel_rotate_secret/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::cancel_rotate_secret::_cancel_rotate_secret_output::CancelRotateSecretOutputBuilder;
3
4pub use crate::operation::cancel_rotate_secret::_cancel_rotate_secret_input::CancelRotateSecretInputBuilder;
5
6impl crate::operation::cancel_rotate_secret::builders::CancelRotateSecretInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::cancel_rotate_secret::CancelRotateSecretOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::cancel_rotate_secret::CancelRotateSecretError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.cancel_rotate_secret();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CancelRotateSecret`.
24///
25/// <p>Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.</p>
26/// <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code> labels in an unexpected state. You might need to remove the staging label <code>AWSPENDING</code> 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 <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>. To determine which version has a specific staging label, call <code>ListSecretVersionIds</code>. Then use <code>UpdateSecretVersionStage</code> to change staging labels. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
27/// <p>To turn on automatic rotation again, call <code>RotateSecret</code>.</p>
28/// <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>
29/// <p><b>Required permissions: </b> <code>secretsmanager:CancelRotateSecret</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>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct CancelRotateSecretFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::cancel_rotate_secret::builders::CancelRotateSecretInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::cancel_rotate_secret::CancelRotateSecretOutput,
39        crate::operation::cancel_rotate_secret::CancelRotateSecretError,
40    > for CancelRotateSecretFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::cancel_rotate_secret::CancelRotateSecretOutput,
48            crate::operation::cancel_rotate_secret::CancelRotateSecretError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl CancelRotateSecretFluentBuilder {
55    /// Creates a new `CancelRotateSecretFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the CancelRotateSecret as a reference.
64    pub fn as_input(&self) -> &crate::operation::cancel_rotate_secret::builders::CancelRotateSecretInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::cancel_rotate_secret::CancelRotateSecretOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::cancel_rotate_secret::CancelRotateSecretError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::cancel_rotate_secret::CancelRotateSecret::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::cancel_rotate_secret::CancelRotateSecret::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::cancel_rotate_secret::CancelRotateSecretOutput,
101        crate::operation::cancel_rotate_secret::CancelRotateSecretError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The ARN or name of the secret.</p>
116    /// <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>
117    pub fn secret_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.secret_id(input.into());
119        self
120    }
121    /// <p>The ARN or name of the secret.</p>
122    /// <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>
123    pub fn set_secret_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_secret_id(input);
125        self
126    }
127    /// <p>The ARN or name of the secret.</p>
128    /// <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>
129    pub fn get_secret_id(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_secret_id()
131    }
132}
aws_sdk_secretsmanager/operation/cancel_rotate_secret/builders.rs

aws_sdk_secretsmanager/operation/cancel_rotate_secret/
builders.rs
