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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_location_smb::_create_location_smb_output::CreateLocationSmbOutputBuilder;
pub use crate::operation::create_location_smb::_create_location_smb_input::CreateLocationSmbInputBuilder;
/// Fluent builder constructing a request to `CreateLocationSmb`.
///
/// <p>Defines a file system on a Server Message Block (SMB) server that can be read from or written to.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateLocationSmbFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_location_smb::builders::CreateLocationSmbInputBuilder,
}
impl CreateLocationSmbFluentBuilder {
/// Creates a new `CreateLocationSmb`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume 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_smb::CreateLocationSmb,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::create_location_smb::CreateLocationSmbError,
>,
> {
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)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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_smb::CreateLocationSmbOutput,
aws_smithy_http::result::SdkError<
crate::operation::create_location_smb::CreateLocationSmbError,
>,
> {
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
}
/// <p>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</p> <note>
/// <p> <code>Subdirectory</code> must be specified with forward slashes. For example, <code>/path/to/folder</code>.</p>
/// </note>
/// <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.</p>
pub fn subdirectory(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subdirectory(input.into());
self
}
/// <p>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</p> <note>
/// <p> <code>Subdirectory</code> must be specified with forward slashes. For example, <code>/path/to/folder</code>.</p>
/// </note>
/// <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.</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 SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.</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 Into<std::string::String>) -> Self {
self.inner = self.inner.server_hostname(input.into());
self
}
/// <p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.</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>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>
/// <p>For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see the <a href="create-smb-location.html#SMBuser">User setting</a> for SMB locations.</p>
pub fn user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user(input.into());
self
}
/// <p>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>
/// <p>For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see the <a href="create-smb-location.html#SMBuser">User setting</a> for SMB locations.</p>
pub fn set_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user(input);
self
}
/// <p>The name of the Windows domain that the SMB server belongs to.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The name of the Windows domain that the SMB server belongs to.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.</p>
pub fn password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.password(input.into());
self
}
/// <p>The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.</p>
pub fn set_password(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_password(input);
self
}
/// Appends an item to `AgentArns`.
///
/// To override the contents of this collection use [`set_agent_arns`](Self::set_agent_arns).
///
/// <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. </p>
pub fn agent_arns(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.agent_arns(input.into());
self
}
/// <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. </p>
pub fn set_agent_arns(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_agent_arns(input);
self
}
/// <p>The mount options used by DataSync to access the SMB server.</p>
pub fn mount_options(mut self, input: crate::types::SmbMountOptions) -> Self {
self.inner = self.inner.mount_options(input);
self
}
/// <p>The mount options used by DataSync to access the SMB server.</p>
pub fn set_mount_options(
mut self,
input: std::option::Option<crate::types::SmbMountOptions>,
) -> 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
}
}