Class CfnLocationNFSProps.Builder

java.lang.Object
software.amazon.awscdk.services.datasync.CfnLocationNFSProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLocationNFSProps>
Enclosing interface:
CfnLocationNFSProps

@Stability(Stable) public static final class CfnLocationNFSProps.Builder extends Object implements software.amazon.jsii.Builder<CfnLocationNFSProps>
A builder for CfnLocationNFSProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • onPremConfig

      @Stability(Stable) public CfnLocationNFSProps.Builder onPremConfig(IResolvable onPremConfig)
      Parameters:
      onPremConfig - Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. This parameter is required. If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.
      Returns:
      this
    • onPremConfig

      @Stability(Stable) public CfnLocationNFSProps.Builder onPremConfig(CfnLocationNFS.OnPremConfigProperty onPremConfig)
      Parameters:
      onPremConfig - Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. This parameter is required. If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.
      Returns:
      this
    • mountOptions

      @Stability(Stable) public CfnLocationNFSProps.Builder mountOptions(IResolvable mountOptions)
      Parameters:
      mountOptions - The NFS mount options that DataSync can use to mount your NFS share.
      Returns:
      this
    • mountOptions

      @Stability(Stable) public CfnLocationNFSProps.Builder mountOptions(CfnLocationNFS.MountOptionsProperty mountOptions)
      Parameters:
      mountOptions - The NFS mount options that DataSync can use to mount your NFS share.
      Returns:
      this
    • serverHostname

      @Stability(Stable) public CfnLocationNFSProps.Builder serverHostname(String serverHostname)
      Parameters:
      serverHostname - The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

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

      Returns:
      this
    • subdirectory

      @Stability(Stable) public CfnLocationNFSProps.Builder subdirectory(String subdirectory)
      Parameters:
      subdirectory - The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

      To see all the paths exported by your NFS server, run " showmount -e nfs-server-name " from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

      To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

      For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

      Returns:
      this
    • tags

      @Stability(Stable) public CfnLocationNFSProps.Builder tags(List<? extends CfnTag> tags)
      Parameters:
      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.
      Returns:
      this
    • build

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