Class CfnLocationNFS

A CloudFormation AWS::DataSync::LocationNFS.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnLocationNFS

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public class CfnLocationNFS : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnLocationNFS
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

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

CloudformationResource: AWS::DataSync::LocationNFS

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;

CfnLocationNFS cfnLocationNFS = new CfnLocationNFS(this, "MyCfnLocationNFS", new CfnLocationNFSProps {
    OnPremConfig = new OnPremConfigProperty {
        AgentArns = new [] { "agentArns" }
    },
    ServerHostname = "serverHostname",
    Subdirectory = "subdirectory",

    // the properties below are optional
    MountOptions = new MountOptionsProperty {
        Version = "version"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnLocationNFS(Construct, String, ICfnLocationNFSProps)	Create a new `AWS::DataSync::LocationNFS`.
CfnLocationNFS(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnLocationNFS(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrLocationArn	The Amazon Resource Name (ARN) of the specified source NFS file system location.
AttrLocationUri	The URI of the specified source NFS location.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
MountOptions	The NFS mount options that DataSync can use to mount your NFS share.
OnPremConfig	Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
ServerHostname	The name of the NFS server.
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.
Tags	The key-value pair that represents the tag that you want to add to the location.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnLocationNFS(Construct, String, ICfnLocationNFSProps)

Create a new AWS::DataSync::LocationNFS.

public CfnLocationNFS(Construct scope, string id, ICfnLocationNFSProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnLocationNFSProps

resource properties.

CfnLocationNFS(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnLocationNFS(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnLocationNFS(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnLocationNFS(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrLocationArn

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

public virtual string AttrLocationArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified source NFS location.

public virtual string AttrLocationUri { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LocationUri

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

MountOptions

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

public virtual object MountOptions { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-mountoptions

OnPremConfig

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

public virtual object OnPremConfig { get; set; }

Property Value

System.Object

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-onpremconfig

ServerHostname

The name of the NFS server.

public virtual string ServerHostname { get; set; }

Property Value

System.String

Remarks

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 host name 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-serverhostname

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.

public virtual string Subdirectory { get; set; }

Property Value

System.String

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-subdirectory

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable