software.amazon.awscdk.services.datasync

Class CfnLocationNFS

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datasync.CfnLocationNFS

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.888Z")
 @Stability(value=Stable)
public class CfnLocationNFS
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationNFS`.

The AWS::DataSync::LocationNFS resource specifies a file system on a Network File System (NFS) server that can be read from or written to.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLocationNFS.Builder A fluent builder for CfnLocationNFS.
static interface	CfnLocationNFS.MountOptionsProperty The NFS mount options that DataSync can use to mount your NFS share.
static interface	CfnLocationNFS.OnPremConfigProperty A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationNFS(software.constructs.Construct scope, String id, CfnLocationNFSProps props) Create a new `AWS::DataSync::LocationNFS`.
protected	CfnLocationNFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationNFS(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrLocationArn() The Amazon Resource Name (ARN) of the specified source NFS file system location.
String	getAttrLocationUri() The URI of the specified source NFS location.
protected Map<String,Object>	getCfnProperties()
Object	getMountOptions() The NFS mount options that DataSync can use to mount your NFS share.
Object	getOnPremConfig() Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
String	getServerHostname() The name of the NFS server.
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.
TagManager	getTags() The key-value pair that represents the tag that you want to add to the location.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMountOptions(CfnLocationNFS.MountOptionsProperty value) The NFS mount options that DataSync can use to mount your NFS share.
void	setMountOptions(IResolvable value) The NFS mount options that DataSync can use to mount your NFS share.
void	setOnPremConfig(CfnLocationNFS.OnPremConfigProperty value) Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
void	setOnPremConfig(IResolvable value) Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
void	setServerHostname(String value) The name of the NFS server.
void	setSubdirectory(String value) 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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationNFS

protected CfnLocationNFS(software.amazon.jsii.JsiiObjectRef objRef)

CfnLocationNFS

protected CfnLocationNFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLocationNFS

@Stability(value=Stable)
public CfnLocationNFS(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnLocationNFSProps props)

Create a new `AWS::DataSync::LocationNFS`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLocationArn

@Stability(value=Stable)
 @NotNull
public String getAttrLocationArn()

The Amazon Resource Name (ARN) of the specified source NFS file system location.

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the specified source NFS location.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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.

getOnPremConfig

@Stability(value=Stable)
 @NotNull
public 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.

setOnPremConfig

@Stability(value=Stable)
public void setOnPremConfig(@NotNull
                                                     CfnLocationNFS.OnPremConfigProperty value)

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.

setOnPremConfig

@Stability(value=Stable)
public void setOnPremConfig(@NotNull
                                                     IResolvable value)

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.

getServerHostname

@Stability(value=Stable)
 @NotNull
public 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.

setServerHostname

@Stability(value=Stable)
public void setServerHostname(@NotNull
                                                       String value)

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

@Stability(value=Stable)
 @NotNull
public 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.

setSubdirectory

@Stability(value=Stable)
public void setSubdirectory(@NotNull
                                                     String value)

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.

getMountOptions

@Stability(value=Stable)
 @Nullable
public Object getMountOptions()

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

setMountOptions

@Stability(value=Stable)
public void setMountOptions(@Nullable
                                                     CfnLocationNFS.MountOptionsProperty value)

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

setMountOptions

@Stability(value=Stable)
public void setMountOptions(@Nullable
                                                     IResolvable value)

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