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

Interface CreateLocationSmbRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>, DataSyncRequest.Builder, SdkBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLocationSmbRequest
public static interface CreateLocationSmbRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>

  • Method Details

    • 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 required permissions for SMB locations.

      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 required permissions for SMB locations.

      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 Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

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

      Parameters:
      serverHostname - Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

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

      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.

      For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

      Parameters:
      user - Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

      For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

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

    • domain

      CreateLocationSmbRequest.Builder domain(String domain)

      Specifies the name of the Active Directory domain that your SMB file server belongs to.

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

      Parameters:
      domain - Specifies the name of the Active Directory domain that your SMB file server belongs to.

      If you have multiple Active Directory 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.

      For more information, see required permissions for SMB locations.

      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.

      For more information, see required permissions for SMB locations.

      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) which you want to 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) which you want to 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) which you want to 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) which you want to 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.

    • mountOptions

      default CreateLocationSmbRequest.Builder mountOptions(Consumer<SmbMountOptions.Builder> mountOptions)

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

      This is a convenience method that creates an instance of the SmbMountOptions.Builder avoiding the need to create one manually via SmbMountOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mountOptions(SmbMountOptions).

      Parameters:
      mountOptions - a consumer that will call methods on SmbMountOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • tags

      CreateLocationSmbRequest.Builder tags(Consumer<TagListEntry.Builder>... 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.

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLocationSmbRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLocationSmbRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.