aws_sdk_datasync/client/
create_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 [`CreateLocationSmb`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`subdirectory(impl Into<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::subdirectory) / [`set_subdirectory(Option<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_subdirectory):<br>required: **true**<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 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>
    ///   - [`server_hostname(impl Into<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::server_hostname) / [`set_server_hostname(Option<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_server_hostname):<br>required: **true**<br><p>Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.</p><note>  <p>You can't specify an IP version 6 (IPv6) address.</p> </note><br>
    ///   - [`user(impl Into<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::user) / [`set_user(Option<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_user):<br>required: **true**<br><p>Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.</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::create_location_smb::builders::CreateLocationSmbFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_domain):<br>required: **false**<br><p>Specifies the name of the Active Directory domain that your SMB file server belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p><br>
    ///   - [`password(impl Into<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_password):<br>required: **true**<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::create_location_smb::builders::CreateLocationSmbFluentBuilder::agent_arns) / [`set_agent_arns(Option<Vec::<String>>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_agent_arns):<br>required: **true**<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::create_location_smb::builders::CreateLocationSmbFluentBuilder::mount_options) / [`set_mount_options(Option<SmbMountOptions>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_mount_options):<br>required: **false**<br><p>Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.</p><br>
    ///   - [`tags(TagListEntry)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::tags) / [`set_tags(Option<Vec::<TagListEntry>>)`](crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::set_tags):<br>required: **false**<br><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><br>
    /// - On success, responds with [`CreateLocationSmbOutput`](crate::operation::create_location_smb::CreateLocationSmbOutput) with field(s):
    ///   - [`location_arn(Option<String>)`](crate::operation::create_location_smb::CreateLocationSmbOutput::location_arn): <p>The ARN of the SMB location that you created.</p>
    /// - On failure, responds with [`SdkError<CreateLocationSmbError>`](crate::operation::create_location_smb::CreateLocationSmbError)
    pub fn create_location_smb(&self) -> crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder {
        crate::operation::create_location_smb::builders::CreateLocationSmbFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_datasync/client/create_location_smb.rs

aws_sdk_datasync/client/
create_location_smb.rs
