Interface UpdateLocationSmbRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>, DataSyncRequest.Builder, SdkBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateLocationSmbRequest

public static interface UpdateLocationSmbRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>
  • Method Details

    • locationArn

      UpdateLocationSmbRequest.Builder locationArn(String locationArn)

      Specifies the ARN of the SMB location that you want to update.

      Parameters:
      locationArn - Specifies the ARN of the SMB location that you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subdirectory

      UpdateLocationSmbRequest.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 specified 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 specified 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.
    • user

      Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

      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 name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

      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

      Specifies the Windows domain name that your SMB file server belongs to.

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

      For more information, see required permissions for SMB locations.

      Parameters:
      domain - Specifies the Windows domain name that your SMB file server belongs to.

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

      For more information, see required permissions for SMB locations.

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

      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

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

      Sets the value of the MountOptions property for this object.
      Parameters:
      mountOptions - The new value for the MountOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • mountOptions

      Sets the value of the MountOptions property for this object. 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:
    • overrideConfiguration

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

      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.