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">Providing DataSync access to SMB file servers</a>.</p><br>
    ///   - [`server_hostname(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::server_hostname) / [`set_server_hostname(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_server_hostname):<br>required: **false**<br><p>Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.</p><note>  <p>If you're using Kerberos authentication, you must specify a domain name.</p> </note><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. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</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">Providing DataSync access to SMB file servers</a>.</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. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>If you have multiple 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::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. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</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>
    ///   - [`authentication_type(SmbAuthenticationType)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::authentication_type) / [`set_authentication_type(Option<SmbAuthenticationType>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_authentication_type):<br>required: **false**<br><p>Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code> authentication.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p><br>
    ///   - [`dns_ip_addresses(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::dns_ip_addresses) / [`set_dns_ip_addresses(Option<Vec::<String>>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_dns_ip_addresses):<br>required: **false**<br><p>Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.</p><br>
    ///   - [`kerberos_principal(impl Into<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::kerberos_principal) / [`set_kerberos_principal(Option<String>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_kerberos_principal):<br>required: **false**<br><p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.</p> <p>A Kerberos principal might look like <code>HOST/kerberosuser@MYDOMAIN.ORG</code>.</p> <p>Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.</p><br>
    ///   - [`kerberos_keytab(Blob)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::kerberos_keytab) / [`set_kerberos_keytab(Option<Blob>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_kerberos_keytab):<br>required: **false**<br><p>Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.</p> <p>To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.</p><br>
    ///   - [`kerberos_krb5_conf(Blob)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::kerberos_krb5_conf) / [`set_kerberos_krb5_conf(Option<Blob>)`](crate::operation::update_location_smb::builders::UpdateLocationSmbFluentBuilder::set_kerberos_krb5_conf):<br>required: **false**<br><p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your Kerberos realm configuration.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</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())
    }
}