Package software.amazon.awssdk.services.datasync.model

Interface CreateLocationSmbRequest.Builder

    • Method Detail

      • subdirectory

        CreateLocationSmbRequest.Builder subdirectory​(String subdirectory)

        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, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

        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 Providing DataSync access to SMB file servers.

        Parameters:
        subdirectory - 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, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

        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 Providing DataSync access to SMB file servers.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverHostname

        CreateLocationSmbRequest.Builder serverHostname​(String serverHostname)

        Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.

        Remember the following when configuring this parameter:

        • You can't specify an IP version 6 (IPv6) address.

        • If you're using Kerberos authentication, you must specify a domain name.

        Parameters:
        serverHostname - Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.

        Remember the following when configuring this parameter:

        • You can't specify an IP version 6 (IPv6) address.

        • If you're using Kerberos authentication, you must specify a domain name.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • user

        CreateLocationSmbRequest.Builder user​(String user)

        Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType is set to NTLM.

        For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

        Parameters:
        user - Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType is set to NTLM .

        For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domain

        CreateLocationSmbRequest.Builder domain​(String domain)

        Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

        Parameters:
        domain - Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • password

        CreateLocationSmbRequest.Builder password​(String password)

        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 AuthenticationType is set to NTLM.

        Parameters:
        password - 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 AuthenticationType is set to NTLM.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • agentArns

        CreateLocationSmbRequest.Builder agentArns​(Collection<String> agentArns)

        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).

        Parameters:
        agentArns - 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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • agentArns

        CreateLocationSmbRequest.Builder agentArns​(String... agentArns)

        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).

        Parameters:
        agentArns - 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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mountOptions

        CreateLocationSmbRequest.Builder mountOptions​(SmbMountOptions mountOptions)

        Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

        Parameters:
        mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateLocationSmbRequest.Builder tags​(Collection<TagListEntry> tags)

        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.

        Parameters:
        tags - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateLocationSmbRequest.Builder tags​(TagListEntry... tags)

        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.

        Parameters:
        tags - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationType

        CreateLocationSmbRequest.Builder authenticationType​(String authenticationType)

        Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

        Parameters:
        authenticationType - Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SmbAuthenticationType, SmbAuthenticationType

      • authenticationType

        CreateLocationSmbRequest.Builder authenticationType​(SmbAuthenticationType authenticationType)

        Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

        Parameters:
        authenticationType - Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SmbAuthenticationType, SmbAuthenticationType

      • dnsIpAddresses

        CreateLocationSmbRequest.Builder dnsIpAddresses​(Collection<String> dnsIpAddresses)

        Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

        Parameters:
        dnsIpAddresses - Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsIpAddresses

        CreateLocationSmbRequest.Builder dnsIpAddresses​(String... dnsIpAddresses)

        Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

        Parameters:
        dnsIpAddresses - Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

        If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kerberosPrincipal

        CreateLocationSmbRequest.Builder kerberosPrincipal​(String kerberosPrincipal)

        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.

        A Kerberos principal might look like HOST/kerberosuser@EXAMPLE.COM.

        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.

        Parameters:
        kerberosPrincipal - 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.

        A Kerberos principal might look like HOST/kerberosuser@EXAMPLE.COM.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kerberosKeytab

        CreateLocationSmbRequest.Builder kerberosKeytab​(SdkBytes kerberosKeytab)

        Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

        The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

        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 KerberosPrincipal.

        Parameters:
        kerberosKeytab - Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

        The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

        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 KerberosPrincipal.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kerberosKrb5Conf

        CreateLocationSmbRequest.Builder kerberosKrb5Conf​(SdkBytes kerberosKrb5Conf)

        Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

        The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

        Parameters:
        kerberosKrb5Conf - Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

        The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

        Returns:
        Returns a reference to this object so that method calls can be chained together.