software.amazon.awscdk.services.datasync

Class CfnLocationNFS.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationNFS.Builder

Enclosing class:

CfnLocationNFS

public static final class CfnLocationNFS.Builder
extends java.lang.Object

A fluent builder for CfnLocationNFS.

Method Summary

Modifier and Type	Method and Description
CfnLocationNFS	build()
static CfnLocationNFS.Builder	create(Construct scope, java.lang.String id)
CfnLocationNFS.Builder	mountOptions(CfnLocationNFS.MountOptionsProperty mountOptions) The NFS mount options that DataSync can use to mount your NFS share.
CfnLocationNFS.Builder	mountOptions(IResolvable mountOptions) The NFS mount options that DataSync can use to mount your NFS share.
CfnLocationNFS.Builder	onPremConfig(CfnLocationNFS.OnPremConfigProperty onPremConfig) Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
CfnLocationNFS.Builder	onPremConfig(IResolvable onPremConfig) Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
CfnLocationNFS.Builder	serverHostname(java.lang.String serverHostname) The name of the NFS server.
CfnLocationNFS.Builder	subdirectory(java.lang.String 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.
CfnLocationNFS.Builder	tags(java.util.List<? extends CfnTag> tags) The key-value pair that represents the tag that you want to add to the location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnLocationNFS.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLocationNFS.MountOptionsProperty.Builder.

onPremConfig

public CfnLocationNFS.Builder onPremConfig(IResolvable onPremConfig)

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.

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.

Returns:

this

onPremConfig

public CfnLocationNFS.Builder onPremConfig(CfnLocationNFS.OnPremConfigProperty onPremConfig)

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.

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.

Returns:

this

mountOptions

public CfnLocationNFS.Builder mountOptions(IResolvable mountOptions)

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

Parameters:

mountOptions - The NFS mount options that DataSync can use to mount your NFS share. This parameter is required.

Returns:

this

mountOptions

public CfnLocationNFS.Builder mountOptions(CfnLocationNFS.MountOptionsProperty mountOptions)

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

Parameters:

mountOptions - The NFS mount options that DataSync can use to mount your NFS share. This parameter is required.

Returns:

this

serverHostname

public CfnLocationNFS.Builder serverHostname(java.lang.String 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.

Parameters:

serverHostname - The name of the NFS server. This parameter is required.

Returns:

this

subdirectory

public CfnLocationNFS.Builder subdirectory(java.lang.String 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.

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. This parameter is required.

Returns:

this

tags

public CfnLocationNFS.Builder tags(java.util.List<? extends CfnTag> 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.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. This parameter is required.

Returns:

this

build

public CfnLocationNFS build()