software.amazon.awscdk.services.datasync

Interface CfnLocationSMBProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationSMBProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.896Z")
 @Stability(value=Stable)
public interface CfnLocationSMBProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLocationSMB`.

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"))
         .password("password")
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .user("user")
         // the properties below are optional
         .domain("domain")
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLocationSMBProps.Builder A builder for CfnLocationSMBProps
static class	CfnLocationSMBProps.Jsii$Proxy An implementation for CfnLocationSMBProps

Method Summary

Modifier and Type	Method and Description
static CfnLocationSMBProps.Builder	builder()
List<String>	getAgentArns() The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
default String	getDomain() The name of the Windows domain that the SMB server belongs to.
default Object	getMountOptions() The mount options used by DataSync to access the SMB server.
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.
String	getServerHostname() The name of the SMB server.
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 List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the location.
String	getUser() The user who can mount the share and has the permissions to access files and folders in the SMB share.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAgentArns

@Stability(value=Stable)
 @NotNull
List<String> getAgentArns()

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

getPassword

@Stability(value=Stable)
 @NotNull
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.

getServerHostname

@Stability(value=Stable)
 @NotNull
String getServerHostname()

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.

getSubdirectory

@Stability(value=Stable)
 @NotNull
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.

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.

getUser

@Stability(value=Stable)
 @NotNull
String getUser()

The user who can mount the share and 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 .

getDomain

@Stability(value=Stable)
 @Nullable
default String getDomain()

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

getMountOptions

@Stability(value=Stable)
 @Nullable
default Object getMountOptions()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(value=Stable)
static CfnLocationSMBProps.Builder builder()

Returns:

a CfnLocationSMBProps.Builder of CfnLocationSMBProps