aws_sdk_storagegateway/operation/attach_volume/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::attach_volume::_attach_volume_output::AttachVolumeOutputBuilder;
3
4pub use crate::operation::attach_volume::_attach_volume_input::AttachVolumeInputBuilder;
5
6impl crate::operation::attach_volume::builders::AttachVolumeInputBuilder {
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::attach_volume::AttachVolumeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::attach_volume::AttachVolumeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.attach_volume();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `AttachVolume`.
24///
25/// <p>Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct AttachVolumeFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::attach_volume::builders::AttachVolumeInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::attach_volume::AttachVolumeOutput,
35        crate::operation::attach_volume::AttachVolumeError,
36    > for AttachVolumeFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::attach_volume::AttachVolumeOutput,
44            crate::operation::attach_volume::AttachVolumeError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl AttachVolumeFluentBuilder {
51    /// Creates a new `AttachVolumeFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the AttachVolume as a reference.
60    pub fn as_input(&self) -> &crate::operation::attach_volume::builders::AttachVolumeInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::attach_volume::AttachVolumeOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::attach_volume::AttachVolumeError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::attach_volume::AttachVolume::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::attach_volume::AttachVolume::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::attach_volume::AttachVolumeOutput,
97        crate::operation::attach_volume::AttachVolumeError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.</p>
112    pub fn gateway_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.gateway_arn(input.into());
114        self
115    }
116    /// <p>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.</p>
117    pub fn set_gateway_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_gateway_arn(input);
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.</p>
122    pub fn get_gateway_arn(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_gateway_arn()
124    }
125    /// <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p>
126    /// <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>
127    pub fn target_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.target_name(input.into());
129        self
130    }
131    /// <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p>
132    /// <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>
133    pub fn set_target_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_target_name(input);
135        self
136    }
137    /// <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p>
138    /// <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>
139    pub fn get_target_name(&self) -> &::std::option::Option<::std::string::String> {
140        self.inner.get_target_name()
141    }
142    /// <p>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</p>
143    pub fn volume_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.volume_arn(input.into());
145        self
146    }
147    /// <p>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</p>
148    pub fn set_volume_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_volume_arn(input);
150        self
151    }
152    /// <p>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</p>
153    pub fn get_volume_arn(&self) -> &::std::option::Option<::std::string::String> {
154        self.inner.get_volume_arn()
155    }
156    /// <p>The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use <code>DescribeGatewayInformation</code> to get a list of the network interfaces available on a gateway.</p>
157    /// <p>Valid Values: A valid IP address.</p>
158    pub fn network_interface_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159        self.inner = self.inner.network_interface_id(input.into());
160        self
161    }
162    /// <p>The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use <code>DescribeGatewayInformation</code> to get a list of the network interfaces available on a gateway.</p>
163    /// <p>Valid Values: A valid IP address.</p>
164    pub fn set_network_interface_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
165        self.inner = self.inner.set_network_interface_id(input);
166        self
167    }
168    /// <p>The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use <code>DescribeGatewayInformation</code> to get a list of the network interfaces available on a gateway.</p>
169    /// <p>Valid Values: A valid IP address.</p>
170    pub fn get_network_interface_id(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_network_interface_id()
172    }
173    /// <p>The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.</p>
174    pub fn disk_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175        self.inner = self.inner.disk_id(input.into());
176        self
177    }
178    /// <p>The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.</p>
179    pub fn set_disk_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180        self.inner = self.inner.set_disk_id(input);
181        self
182    }
183    /// <p>The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.</p>
184    pub fn get_disk_id(&self) -> &::std::option::Option<::std::string::String> {
185        self.inner.get_disk_id()
186    }
187}
aws_sdk_storagegateway/operation/attach_volume/builders.rs

aws_sdk_storagegateway/operation/attach_volume/
builders.rs
