software.amazon.awssdk.services.datasync.model

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 Summary

Modifier and Type	Method and Description
UpdateLocationSmbRequest.Builder	agentArns(Collection<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
UpdateLocationSmbRequest.Builder	agentArns(String... agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
UpdateLocationSmbRequest.Builder	domain(String domain) The name of the Windows domain that the SMB server belongs to.
UpdateLocationSmbRequest.Builder	locationArn(String locationArn) The Amazon Resource Name (ARN) of the SMB location to update.
default UpdateLocationSmbRequest.Builder	mountOptions(Consumer<SmbMountOptions.Builder> mountOptions) Sets the value of the MountOptions property for this object.
UpdateLocationSmbRequest.Builder	mountOptions(SmbMountOptions mountOptions) Sets the value of the MountOptions property for this object.
UpdateLocationSmbRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateLocationSmbRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateLocationSmbRequest.Builder	password(String password) The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
UpdateLocationSmbRequest.Builder	subdirectory(String subdirectory) The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
UpdateLocationSmbRequest.Builder	user(String user) The user who can mount the share has the permissions to access files and folders in the SMB share.

Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

locationArn

UpdateLocationSmbRequest.Builder locationArn(String locationArn)

The Amazon Resource Name (ARN) of the SMB location to update.

Parameters:

locationArn - The Amazon Resource Name (ARN) of the SMB location to update.

Returns:

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

subdirectory

UpdateLocationSmbRequest.Builder subdirectory(String subdirectory)

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

• Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

Parameters:

subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

• Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

Returns:

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

user

UpdateLocationSmbRequest.Builder user(String user)

The user who can mount the share has the permissions to access files and folders in the SMB share.

Parameters:

user - The user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

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

domain

UpdateLocationSmbRequest.Builder domain(String domain)

The name of the Windows domain that the SMB server belongs to.

Parameters:

domain - The name of the Windows domain that the SMB server belongs to.

Returns:

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

password

UpdateLocationSmbRequest.Builder password(String password)

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

Parameters:

password - The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

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

agentArns

UpdateLocationSmbRequest.Builder agentArns(Collection<String> agentArns)

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Parameters:

agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

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

agentArns

UpdateLocationSmbRequest.Builder agentArns(String... agentArns)

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Parameters:

agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

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

mountOptions

UpdateLocationSmbRequest.Builder mountOptions(SmbMountOptions 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

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

Sets the value of the MountOptions property for this object. This is a convenience 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:

mountOptions(SmbMountOptions)

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

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