aws_sdk_datasync/client/update_location_smb.rs
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`UpdateLocationSmb`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`location_arn(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::location_arn) / [`set_location_arn(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_location_arn):<br>required: **true**<br><p>Specifies the ARN of the SMB location that you want to update.</p><br>
/// - [`subdirectory(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::subdirectory) / [`set_subdirectory(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_subdirectory):<br>required: **false**<br><p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p><br>
/// - [`user(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::user) / [`set_user(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_user):<br>required: **false**<br><p>Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p><br>
/// - [`domain(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_domain):<br>required: **false**<br><p>Specifies the Windows domain name that your SMB file server belongs to.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p><br>
/// - [`password(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_password):<br>required: **false**<br><p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p><br>
/// - [`agent_arns(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::agent_arns) / [`set_agent_arns(Option<Vec::<String>>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_agent_arns):<br>required: **false**<br><p>Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).</p><br>
/// - [`mount_options(SmbMountOptions)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::mount_options) / [`set_mount_options(Option<SmbMountOptions>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_mount_options):<br>required: **false**<br><p>Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.</p><br>
/// - On success, responds with [`UpdateLocationSmbOutput`](crate::operation::update_location_smb::UpdateLocationSmbOutput)
/// - On failure, responds with [`SdkError<UpdateLocationSmbError>`](crate::operation::update_location_smb::UpdateLocationSmbError)
pub fn update_location_smb(&self) -> crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder {
crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::new(self.handle.clone())
}
}