aws_sdk_datasync/operation/create_location_fsx_ontap/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_location_fsx_ontap::_create_location_fsx_ontap_output::CreateLocationFsxOntapOutputBuilder;
3
4pub use crate::operation::create_location_fsx_ontap::_create_location_fsx_ontap_input::CreateLocationFsxOntapInputBuilder;
5
6impl crate::operation::create_location_fsx_ontap::builders::CreateLocationFsxOntapInputBuilder {
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::create_location_fsx_ontap::CreateLocationFsxOntapOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_location_fsx_ontap();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateLocationFsxOntap`.
24///
25/// <p>Creates a transfer <i>location</i> for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.</p>
26/// <p>Before you begin, make sure that you understand how DataSync <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">accesses FSx for ONTAP file systems</a>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateLocationFsxOntapFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::create_location_fsx_ontap::builders::CreateLocationFsxOntapInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapOutput,
36 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapError,
37 > for CreateLocationFsxOntapFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapOutput,
45 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl CreateLocationFsxOntapFluentBuilder {
52 /// Creates a new `CreateLocationFsxOntapFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the CreateLocationFsxOntap as a reference.
61 pub fn as_input(&self) -> &crate::operation::create_location_fsx_ontap::builders::CreateLocationFsxOntapInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::create_location_fsx_ontap::CreateLocationFsxOntap::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntap::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapOutput,
98 crate::operation::create_location_fsx_ontap::CreateLocationFsxOntapError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
113 pub fn protocol(mut self, input: crate::types::FsxProtocol) -> Self {
114 self.inner = self.inner.protocol(input);
115 self
116 }
117 /// <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
118 pub fn set_protocol(mut self, input: ::std::option::Option<crate::types::FsxProtocol>) -> Self {
119 self.inner = self.inner.set_protocol(input);
120 self
121 }
122 /// <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
123 pub fn get_protocol(&self) -> &::std::option::Option<crate::types::FsxProtocol> {
124 self.inner.get_protocol()
125 }
126 ///
127 /// Appends an item to `SecurityGroupArns`.
128 ///
129 /// To override the contents of this collection use [`set_security_group_arns`](Self::set_security_group_arns).
130 ///
131 /// <p>Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p>
132 /// <p>The security groups must allow outbound traffic on the following ports (depending on the protocol you use):</p>
133 /// <ul>
134 /// <li>
135 /// <p><b>Network File System (NFS)</b>: TCP ports 111, 635, and 2049</p></li>
136 /// <li>
137 /// <p><b>Server Message Block (SMB)</b>: TCP port 445</p></li>
138 /// </ul>
139 /// <p>Your file system's security groups must also allow inbound traffic on the same ports.</p>
140 pub fn security_group_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141 self.inner = self.inner.security_group_arns(input.into());
142 self
143 }
144 /// <p>Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p>
145 /// <p>The security groups must allow outbound traffic on the following ports (depending on the protocol you use):</p>
146 /// <ul>
147 /// <li>
148 /// <p><b>Network File System (NFS)</b>: TCP ports 111, 635, and 2049</p></li>
149 /// <li>
150 /// <p><b>Server Message Block (SMB)</b>: TCP port 445</p></li>
151 /// </ul>
152 /// <p>Your file system's security groups must also allow inbound traffic on the same ports.</p>
153 pub fn set_security_group_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
154 self.inner = self.inner.set_security_group_arns(input);
155 self
156 }
157 /// <p>Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p>
158 /// <p>The security groups must allow outbound traffic on the following ports (depending on the protocol you use):</p>
159 /// <ul>
160 /// <li>
161 /// <p><b>Network File System (NFS)</b>: TCP ports 111, 635, and 2049</p></li>
162 /// <li>
163 /// <p><b>Server Message Block (SMB)</b>: TCP port 445</p></li>
164 /// </ul>
165 /// <p>Your file system's security groups must also allow inbound traffic on the same ports.</p>
166 pub fn get_security_group_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
167 self.inner.get_security_group_arns()
168 }
169 /// <p>Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.</p>
170 pub fn storage_virtual_machine_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171 self.inner = self.inner.storage_virtual_machine_arn(input.into());
172 self
173 }
174 /// <p>Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.</p>
175 pub fn set_storage_virtual_machine_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176 self.inner = self.inner.set_storage_virtual_machine_arn(input);
177 self
178 }
179 /// <p>Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.</p>
180 pub fn get_storage_virtual_machine_arn(&self) -> &::std::option::Option<::std::string::String> {
181 self.inner.get_storage_virtual_machine_arn()
182 }
183 /// <p>Specifies a path to the file share in the SVM where you want to transfer data to or from.</p>
184 /// <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p><note>
185 /// <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
186 /// </note>
187 pub fn subdirectory(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
188 self.inner = self.inner.subdirectory(input.into());
189 self
190 }
191 /// <p>Specifies a path to the file share in the SVM where you want to transfer data to or from.</p>
192 /// <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p><note>
193 /// <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
194 /// </note>
195 pub fn set_subdirectory(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
196 self.inner = self.inner.set_subdirectory(input);
197 self
198 }
199 /// <p>Specifies a path to the file share in the SVM where you want to transfer data to or from.</p>
200 /// <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p><note>
201 /// <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
202 /// </note>
203 pub fn get_subdirectory(&self) -> &::std::option::Option<::std::string::String> {
204 self.inner.get_subdirectory()
205 }
206 ///
207 /// Appends an item to `Tags`.
208 ///
209 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
210 ///
211 /// <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
212 pub fn tags(mut self, input: crate::types::TagListEntry) -> Self {
213 self.inner = self.inner.tags(input);
214 self
215 }
216 /// <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
217 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagListEntry>>) -> Self {
218 self.inner = self.inner.set_tags(input);
219 self
220 }
221 /// <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
222 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagListEntry>> {
223 self.inner.get_tags()
224 }
225}