Class CfnLocationNFS
The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocationNFS : CfnResource, IInspectable, ILocationNFSRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnLocationNFS Inherits CfnResource Implements IInspectable, ILocationNFSRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
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;
var cfnLocationNFS = new CfnLocationNFS(this, "MyCfnLocationNFS", new CfnLocationNFSProps {
OnPremConfig = new OnPremConfigProperty {
AgentArns = new [] { "agentArns" }
},
// the properties below are optional
MountOptions = new MountOptionsProperty {
Version = "version"
},
ServerHostname = "serverHostname",
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnLocationNFS(Construct, string, ICfnLocationNFSProps) | Create a new |
Properties
| AttrLocationArn | The Amazon Resource Name (ARN) of the NFS location that you created. |
| AttrLocationUri | The URI of the NFS location that you created. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| LocationNfsRef | A reference to a LocationNFS resource. |
| MountOptions | Specifies the options that DataSync can use to mount your NFS file server. |
| OnPremConfig | Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server. |
| ServerHostname | Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to. |
| Subdirectory | Specifies the export path in your NFS file server that you want DataSync to mount. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | Specifies labels that help you categorize, filter, and search for your AWS resources. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnLocationNFS(object) | Checks whether the given object is a CfnLocationNFS. |
| RenderProperties(IDictionary<string, object>) | The |
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 string
Construct identifier for this resource (unique in its scope).
- props ICfnLocationNFSProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
Properties
AttrLocationArn
The Amazon Resource Name (ARN) of the NFS location that you created.
public virtual string AttrLocationArn { get; }
Property Value
Remarks
CloudformationAttribute: LocationArn
AttrLocationUri
The URI of the NFS location that you created.
public virtual string AttrLocationUri { get; }
Property Value
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
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
LocationNfsRef
A reference to a LocationNFS resource.
public virtual ILocationNFSReference LocationNfsRef { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
MountOptions
Specifies the options that DataSync can use to mount your NFS file server.
public virtual object? MountOptions { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnLocationNFS.IMountOptionsProperty
OnPremConfig
Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.
public virtual object OnPremConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnLocationNFS.IOnPremConfigProperty
ServerHostname
Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.
public virtual string? ServerHostname { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
Subdirectory
Specifies the export path in your NFS file server that you want DataSync to mount.
public virtual string? Subdirectory { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
TagsRaw
Specifies labels that help you categorize, filter, and search for your AWS resources.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
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.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
IsCfnLocationNFS(object)
Checks whether the given object is a CfnLocationNFS.
public static bool IsCfnLocationNFS(object x)
Parameters
- x object
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource: AWS::DataSync::LocationNFS
ExampleMetadata: fixture=_generated