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

Class CreateLocationSmbRequest

    • Method Detail

      • subdirectory

        public final 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.

        Returns:
        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.

      • serverHostname

        public final 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.

        Returns:
        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.

      • user

        public final 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.

        Returns:
        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.

      • domain

        public final 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.

        Returns:
        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.

      • password

        public final 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.

        Returns:
        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.

      • hasAgentArns

        public final boolean hasAgentArns()
        For responses, this returns true if the service returned a value for the AgentArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • agentArns

        public final List<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).

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAgentArns() method.

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

      • mountOptions

        public final SmbMountOptions mountOptions()

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

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • authenticationType

        public final SmbAuthenticationType authenticationType()

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

        If the service returns an enum value that is not available in the current SDK version, authenticationType will return SmbAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

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

      • authenticationTypeAsString

        public final String authenticationTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, authenticationType will return SmbAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

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

      • hasDnsIpAddresses

        public final boolean hasDnsIpAddresses()
        For responses, this returns true if the service returned a value for the DnsIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • dnsIpAddresses

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIpAddresses() method.

        Returns:
        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.

      • kerberosPrincipal

        public final 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.

        Returns:
        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.

      • kerberosKeytab

        public final 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.

        Returns:
        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.

      • kerberosKrb5Conf

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object