Class CfnLocationFSxONTAP
The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocationFSxONTAP : CfnResource, IInspectable, ILocationFSxONTAPRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnLocationFSxONTAP Inherits CfnResource Implements IInspectable, ILocationFSxONTAPRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
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 cfnLocationFSxONTAP = new CfnLocationFSxONTAP(this, "MyCfnLocationFSxONTAP", new CfnLocationFSxONTAPProps {
SecurityGroupArns = new [] { "securityGroupArns" },
StorageVirtualMachineArn = "storageVirtualMachineArn",
// the properties below are optional
Protocol = new ProtocolProperty {
Nfs = new NFSProperty {
MountOptions = new NfsMountOptionsProperty {
Version = "version"
}
},
Smb = new SMBProperty {
MountOptions = new SmbMountOptionsProperty {
Version = "version"
},
Password = "password",
User = "user",
// the properties below are optional
Domain = "domain"
}
},
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnLocationFSxONTAP(Construct, string, ICfnLocationFSxONTAPProps) | Create a new |
Properties
| AttrFsxFilesystemArn | The ARN of the FSx for ONTAP file system in the specified location. |
| AttrLocationArn | The ARN of the specified location. |
| AttrLocationUri | The URI of the specified location. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| LocationFSxOntapRef | A reference to a LocationFSxONTAP resource. |
| Protocol | Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system. |
| SecurityGroupArns | Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. |
| StorageVirtualMachineArn | Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from. |
| Subdirectory | Specifies a path to the file share in the SVM where you want to transfer data to or from. |
| 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. |
| IsCfnLocationFSxONTAP(object) | Checks whether the given object is a CfnLocationFSxONTAP. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnLocationFSxONTAP(Construct, string, ICfnLocationFSxONTAPProps)
Create a new AWS::DataSync::LocationFSxONTAP.
public CfnLocationFSxONTAP(Construct scope, string id, ICfnLocationFSxONTAPProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnLocationFSxONTAPProps
Resource properties.
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
Properties
AttrFsxFilesystemArn
The ARN of the FSx for ONTAP file system in the specified location.
public virtual string AttrFsxFilesystemArn { get; }
Property Value
Remarks
CloudformationAttribute: FsxFilesystemArn
AttrLocationArn
The ARN of the specified location.
public virtual string AttrLocationArn { get; }
Property Value
Remarks
CloudformationAttribute: LocationArn
AttrLocationUri
The URI of the specified location.
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
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
LocationFSxOntapRef
A reference to a LocationFSxONTAP resource.
public virtual ILocationFSxONTAPReference LocationFSxOntapRef { get; }
Property Value
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
Protocol
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
public virtual object? Protocol { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnLocationFSxONTAP.IProtocolProperty
SecurityGroupArns
Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system.
public virtual string[] SecurityGroupArns { get; set; }
Property Value
string[]
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
StorageVirtualMachineArn
Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
public virtual string StorageVirtualMachineArn { get; set; }
Property Value
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
Subdirectory
Specifies a path to the file share in the SVM where you want to transfer data to or from.
public virtual string? Subdirectory { get; set; }
Property Value
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
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
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
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
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
IsCfnLocationFSxONTAP(object)
Checks whether the given object is a CfnLocationFSxONTAP.
public static bool IsCfnLocationFSxONTAP(object x)
Parameters
- x object
Returns
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
AWS DataSync can access this endpoint as a source or destination location.
CloudformationResource: AWS::DataSync::LocationFSxONTAP
ExampleMetadata: fixture=_generated