Package software.amazon.awscdk.services.datasync

Class CfnLocationSMBProps.Builder

java.lang.Object
software.amazon.awscdk.services.datasync.CfnLocationSMBProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLocationSMBProps>
Enclosing interface:
CfnLocationSMBProps
@Stability(Stable) public static final class CfnLocationSMBProps.Builder extends Object implements software.amazon.jsii.Builder<CfnLocationSMBProps>
A builder for CfnLocationSMBProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • agentArns

      @Stability(Stable) public CfnLocationSMBProps.Builder agentArns(List<String> agentArns)
      Sets the value of CfnLocationSMBProps.getAgentArns()
      Parameters:
      agentArns - The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location. This parameter is required.
      Returns:
      this

    • user

      @Stability(Stable) public CfnLocationSMBProps.Builder user(String user)
      Sets the value of CfnLocationSMBProps.getUser()
      Parameters:
      user - The user who can mount the share and has the permissions to access files and folders in the SMB share. This parameter is required. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .
      Returns:
      this

    • domain

      @Stability(Stable) public CfnLocationSMBProps.Builder domain(String domain)
      Sets the value of CfnLocationSMBProps.getDomain()
      Parameters:
      domain - Specifies the Windows domain name that your SMB file server belongs to. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

      For more information, see required permissions for SMB locations.

      Returns:
      this

    • mountOptions

      @Stability(Stable) public CfnLocationSMBProps.Builder mountOptions(IResolvable mountOptions)
      Sets the value of CfnLocationSMBProps.getMountOptions()
      Parameters:
      mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
      Returns:
      this

    • mountOptions

      @Stability(Stable) public CfnLocationSMBProps.Builder mountOptions(CfnLocationSMB.MountOptionsProperty mountOptions)
      Sets the value of CfnLocationSMBProps.getMountOptions()
      Parameters:
      mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
      Returns:
      this

    • password

      @Stability(Stable) public CfnLocationSMBProps.Builder password(String password)
      Sets the value of CfnLocationSMBProps.getPassword()
      Parameters:
      password - The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
      Returns:
      this

    • serverHostname

      @Stability(Stable) public CfnLocationSMBProps.Builder serverHostname(String serverHostname)
      Sets the value of CfnLocationSMBProps.getServerHostname()
      Parameters:
      serverHostname - 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.

      Returns:
      this

    • subdirectory

      @Stability(Stable) public CfnLocationSMBProps.Builder subdirectory(String subdirectory)
      Sets the value of CfnLocationSMBProps.getSubdirectory()
      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 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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnLocationSMBProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnLocationSMBProps.getTags()
      Parameters:
      tags - Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
      Returns:
      this

    • build

      @Stability(Stable) public CfnLocationSMBProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnLocationSMBProps>
      Returns:
      a new instance of CfnLocationSMBProps
      Throws:
      NullPointerException - if any required attribute was not provided