Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.211Z") @Stability(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"))
         .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();

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    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()
    Specifies the Windows domain name that your SMB file server belongs to.
    default Object
    getMountOptions()
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    default 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 String
    getServerHostname()
    Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
    default 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()
    Specifies labels that help you categorize, filter, and search for your AWS resources.
    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 Details

    • getAgentArns

      @Stability(Stable) @NotNull List<String> getAgentArns()
      The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

    • getUser

      @Stability(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(Stable) @Nullable default String getDomain()
      Specifies the Windows domain name that your SMB file server belongs to.

      For more information, see required permissions for SMB locations.

    • getMountOptions

      @Stability(Stable) @Nullable default Object getMountOptions()
      Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

    • getPassword

      @Stability(Stable) @Nullable default 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(Stable) @Nullable default String getServerHostname()
      Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

      You can't specify an IP version 6 (IPv6) address.

    • getSubdirectory

      @Stability(Stable) @Nullable default 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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

      We recommend creating at least a name tag for your location.

    • builder

      @Stability(Stable) static CfnLocationSMBProps.Builder builder()
      Returns:
      a CfnLocationSMBProps.Builder of CfnLocationSMBProps