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 Summary

Modifier and Type	Method and Description
CreateLocationSmbRequest.Builder	agentArns(Collection<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
CreateLocationSmbRequest.Builder	agentArns(String... agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
CreateLocationSmbRequest.Builder	domain(String domain) The name of the Windows domain that the SMB server belongs to.
default CreateLocationSmbRequest.Builder	mountOptions(Consumer<SmbMountOptions.Builder> mountOptions) The mount options used by DataSync to access the SMB server.
CreateLocationSmbRequest.Builder	mountOptions(SmbMountOptions mountOptions) The mount options used by DataSync to access the SMB server.
CreateLocationSmbRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateLocationSmbRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateLocationSmbRequest.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.
CreateLocationSmbRequest.Builder	serverHostname(String serverHostname) The name of the SMB server.
CreateLocationSmbRequest.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.
CreateLocationSmbRequest.Builder	tags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest.Builder	tags(Consumer<TagListEntry.Builder>... tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest.Builder	tags(TagListEntry... tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest.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

subdirectory

CreateLocationSmbRequest.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 you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either 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, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally 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 you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either 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, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Returns:

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

serverHostname

CreateLocationSmbRequest.Builder serverHostname(String serverHostname)

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Parameters:

serverHostname - The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Returns:

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

user

CreateLocationSmbRequest.Builder user(String user)

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

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Parameters:

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

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Returns:

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

domain

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

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

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

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

CreateLocationSmbRequest.Builder mountOptions(SmbMountOptions mountOptions)

The mount options used by DataSync to access the SMB server.

Parameters:

mountOptions - The mount options used by DataSync to access the SMB 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)

The mount options used by DataSync to access the SMB server.

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)

tags

CreateLocationSmbRequest.Builder tags(Collection<TagListEntry> tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Returns:

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

tags

CreateLocationSmbRequest.Builder tags(TagListEntry... tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Returns:

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

tags

CreateLocationSmbRequest.Builder tags(Consumer<TagListEntry.Builder>... tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

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.