aws_sdk_storagegateway/operation/update_chap_credentials/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_chap_credentials::_update_chap_credentials_output::UpdateChapCredentialsOutputBuilder;
3
4pub use crate::operation::update_chap_credentials::_update_chap_credentials_input::UpdateChapCredentialsInputBuilder;
5
6impl crate::operation::update_chap_credentials::builders::UpdateChapCredentialsInputBuilder {
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::update_chap_credentials::UpdateChapCredentialsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_chap_credentials::UpdateChapCredentialsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_chap_credentials();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateChapCredentials`.
24///
25/// <p>Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.</p><important>
26/// <p>When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.</p>
27/// </important>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateChapCredentialsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_chap_credentials::builders::UpdateChapCredentialsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_chap_credentials::UpdateChapCredentialsOutput,
37        crate::operation::update_chap_credentials::UpdateChapCredentialsError,
38    > for UpdateChapCredentialsFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::update_chap_credentials::UpdateChapCredentialsOutput,
46            crate::operation::update_chap_credentials::UpdateChapCredentialsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdateChapCredentialsFluentBuilder {
53    /// Creates a new `UpdateChapCredentialsFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the UpdateChapCredentials as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_chap_credentials::builders::UpdateChapCredentialsInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::update_chap_credentials::UpdateChapCredentialsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_chap_credentials::UpdateChapCredentialsError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::update_chap_credentials::UpdateChapCredentials::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_chap_credentials::UpdateChapCredentials::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::update_chap_credentials::UpdateChapCredentialsOutput,
99        crate::operation::update_chap_credentials::UpdateChapCredentialsError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <code>DescribeStorediSCSIVolumes</code> operation to return the TargetARN for specified VolumeARN.</p>
114    pub fn target_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.target_arn(input.into());
116        self
117    }
118    /// <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <code>DescribeStorediSCSIVolumes</code> operation to return the TargetARN for specified VolumeARN.</p>
119    pub fn set_target_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_target_arn(input);
121        self
122    }
123    /// <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <code>DescribeStorediSCSIVolumes</code> operation to return the TargetARN for specified VolumeARN.</p>
124    pub fn get_target_arn(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_target_arn()
126    }
127    /// <p>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p><note>
128    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
129    /// </note>
130    pub fn secret_to_authenticate_initiator(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131        self.inner = self.inner.secret_to_authenticate_initiator(input.into());
132        self
133    }
134    /// <p>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p><note>
135    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
136    /// </note>
137    pub fn set_secret_to_authenticate_initiator(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_secret_to_authenticate_initiator(input);
139        self
140    }
141    /// <p>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p><note>
142    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
143    /// </note>
144    pub fn get_secret_to_authenticate_initiator(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_secret_to_authenticate_initiator()
146    }
147    /// <p>The iSCSI initiator that connects to the target.</p>
148    pub fn initiator_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
149        self.inner = self.inner.initiator_name(input.into());
150        self
151    }
152    /// <p>The iSCSI initiator that connects to the target.</p>
153    pub fn set_initiator_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
154        self.inner = self.inner.set_initiator_name(input);
155        self
156    }
157    /// <p>The iSCSI initiator that connects to the target.</p>
158    pub fn get_initiator_name(&self) -> &::std::option::Option<::std::string::String> {
159        self.inner.get_initiator_name()
160    }
161    /// <p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p>
162    /// <p>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</p><note>
163    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
164    /// </note>
165    pub fn secret_to_authenticate_target(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166        self.inner = self.inner.secret_to_authenticate_target(input.into());
167        self
168    }
169    /// <p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p>
170    /// <p>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</p><note>
171    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
172    /// </note>
173    pub fn set_secret_to_authenticate_target(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_secret_to_authenticate_target(input);
175        self
176    }
177    /// <p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p>
178    /// <p>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</p><note>
179    /// <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p>
180    /// </note>
181    pub fn get_secret_to_authenticate_target(&self) -> &::std::option::Option<::std::string::String> {
182        self.inner.get_secret_to_authenticate_target()
183    }
184}
aws_sdk_storagegateway/operation/update_chap_credentials/builders.rs

aws_sdk_storagegateway/operation/update_chap_credentials/
builders.rs
