@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:28:56.881Z")
public interface CfnLocationSMBProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.datasync.*; CfnLocationSMBProps cfnLocationSMBProps = CfnLocationSMBProps.builder() .agentArns(List.of("agentArns")) .user("user") // the properties below are optional .domain("domain") .mountOptions(MountOptionsProperty.builder() .version("version") .build()) .password("password") .serverHostname("serverHostname") .subdirectory("subdirectory") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnLocationSMBProps.Builder
A builder for
CfnLocationSMBProps |
static class |
CfnLocationSMBProps.Jsii$Proxy
An implementation for
CfnLocationSMBProps |
Modifier and Type | Method and Description |
---|---|
static CfnLocationSMBProps.Builder |
builder() |
java.util.List<java.lang.String> |
getAgentArns()
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
|
default java.lang.String |
getDomain()
Specifies the Windows domain name that your SMB file server belongs to.
|
default java.lang.Object |
getMountOptions()
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
default java.lang.String |
getPassword()
The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
|
default java.lang.String |
getServerHostname()
Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
|
default java.lang.String |
getSubdirectory()
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.
|
default java.util.List<CfnTag> |
getTags()
Specifies labels that help you categorize, filter, and search for your AWS resources.
|
java.lang.String |
getUser()
The user who can mount the share and has the permissions to access files and folders in the SMB share.
|
java.util.List<java.lang.String> getAgentArns()
java.lang.String getUser()
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .
default java.lang.String getDomain()
For more information, see required permissions for SMB locations.
default java.lang.Object getMountOptions()
default java.lang.String getPassword()
default java.lang.String getServerHostname()
You can't specify an IP version 6 (IPv6) address.
default java.lang.String getSubdirectory()
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 must have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either make sure that the user name and 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 one enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.
default java.util.List<CfnTag> getTags()
We recommend creating at least a name tag for your location.
static CfnLocationSMBProps.Builder builder()
CfnLocationSMBProps.Builder
of CfnLocationSMBProps