software.amazon.awssdk.services.datasync.model

Class CreateLocationSmbRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateLocationSmbRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLocationSmbRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>

CreateLocationSmbRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLocationSmbRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentArns() The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
static CreateLocationSmbRequest.Builder	builder()
String	domain() The name of the domain that the SMB server belongs to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SmbMountOptions	mountOptions() The mount options that are available for DataSync to use to access an SMB location.
String	password() The password of the user who has permission to access the SMB server.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLocationSmbRequest.Builder>	serializableBuilderClass()
String	serverHostname() The name of the SMB server.
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.
List<TagListEntry>	tags() The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	user() The user who can mount the share, has the permissions to access files and directories in the SMB share.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

subdirectory

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

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:

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.

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.

serverHostname

public 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 host name 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:

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 host name to mount the SMB server in a network.

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

user

public String user()

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

Returns:

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

domain

public String domain()

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

Returns:

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

password

public String password()

The password of the user who has permission to access the SMB server.

Returns:

The password of the user who has permission to access the SMB server.

agentArns

public List<String> agentArns()

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

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

Returns:

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

mountOptions

public SmbMountOptions mountOptions()

The mount options that are available for DataSync to use to access an SMB location.

Returns:

The mount options that are available for DataSync to use to access an SMB location.

tags

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

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

Returns:

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.

toBuilder

public CreateLocationSmbRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static CreateLocationSmbRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLocationSmbRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo