software.amazon.awscdk.services.datasync

Interface CfnLocationNFSProps

All Known Implementing Classes:

CfnLocationNFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.769Z")
public interface CfnLocationNFSProps

Properties for defining a `CfnLocationNFS`.

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.*;
 CfnLocationNFSProps cfnLocationNFSProps = CfnLocationNFSProps.builder()
         .onPremConfig(OnPremConfigProperty.builder()
                 .agentArns(List.of("agentArns"))
                 .build())
         // the properties below are optional
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLocationNFSProps.Builder	builder()
default java.lang.Object	getMountOptions() The NFS mount options that DataSync can use to mount your NFS share.
java.lang.Object	getOnPremConfig() Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
default java.lang.String	getServerHostname() The name of the NFS server.
default java.lang.String	getSubdirectory() 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.
default java.util.List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the location.

Method Detail

getOnPremConfig

java.lang.Object getOnPremConfig()

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

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

getMountOptions

default java.lang.Object getMountOptions()

The NFS mount options that DataSync can use to mount your NFS share.

getServerHostname

default java.lang.String getServerHostname()

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.

getSubdirectory

default java.lang.String getSubdirectory()

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.

getTags

default java.util.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

static CfnLocationNFSProps.Builder builder()

Returns:

a CfnLocationNFSProps.Builder of CfnLocationNFSProps