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 181 182 183 184 185 186 187
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_location_nfs::_create_location_nfs_output::CreateLocationNfsOutputBuilder;
pub use crate::operation::create_location_nfs::_create_location_nfs_input::CreateLocationNfsInputBuilder;
/// Fluent builder constructing a request to `CreateLocationNfs`.
///
/// <p>Defines a file system on a Network File System (NFS) server that can be read from or written to.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateLocationNfsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_location_nfs::builders::CreateLocationNfsInputBuilder,
}
impl CreateLocationNfsFluentBuilder {
/// Creates a new `CreateLocationNfs`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn customize_middleware(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_location_nfs::CreateLocationNfs,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::create_location_nfs::CreateLocationNfsError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
::std::result::Result::Ok(crate::client::customize::CustomizableOperation {
handle,
operation,
})
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn send_middleware(
self,
) -> ::std::result::Result<
crate::operation::create_location_nfs::CreateLocationNfsOutput,
::aws_smithy_http::result::SdkError<
crate::operation::create_location_nfs::CreateLocationNfsError,
>,
> {
let op = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// 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::create_location_nfs::CreateLocationNfsOutput,
::aws_smithy_http::result::SdkError<
crate::operation::create_location_nfs::CreateLocationNfsError,
>,
> {
self.send_middleware().await
}
/// Consumes this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_location_nfs::CreateLocationNfs,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::create_location_nfs::CreateLocationNfsError,
>,
> {
self.customize_middleware().await
}
/// <p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p>
/// <p>To see all the paths exported by your NFS server, run "<code>showmount -e nfs-server-name</code>" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p>
/// <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
/// <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>
pub fn subdirectory(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.subdirectory(input.into());
self
}
/// <p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p>
/// <p>To see all the paths exported by your NFS server, run "<code>showmount -e nfs-server-name</code>" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p>
/// <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
/// <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>
pub fn set_subdirectory(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_subdirectory(input);
self
}
/// <p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network. </p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p> <note>
/// <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p>
/// </note>
pub fn server_hostname(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.server_hostname(input.into());
self
}
/// <p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network. </p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p> <note>
/// <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p>
/// </note>
pub fn set_server_hostname(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_server_hostname(input);
self
}
/// <p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. </p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
pub fn on_prem_config(mut self, input: crate::types::OnPremConfig) -> Self {
self.inner = self.inner.on_prem_config(input);
self
}
/// <p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. </p>
/// <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
pub fn set_on_prem_config(
mut self,
input: ::std::option::Option<crate::types::OnPremConfig>,
) -> Self {
self.inner = self.inner.set_on_prem_config(input);
self
}
/// <p>The NFS mount options that DataSync can use to mount your NFS share.</p>
pub fn mount_options(mut self, input: crate::types::NfsMountOptions) -> Self {
self.inner = self.inner.mount_options(input);
self
}
/// <p>The NFS mount options that DataSync can use to mount your NFS share.</p>
pub fn set_mount_options(
mut self,
input: ::std::option::Option<crate::types::NfsMountOptions>,
) -> Self {
self.inner = self.inner.set_mount_options(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>
pub fn tags(mut self, input: crate::types::TagListEntry) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>
pub fn set_tags(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::TagListEntry>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}