Show / Hide Table of Contents

Class CfnLocationFSxONTAP

A CloudFormation AWS::DataSync::LocationFSxONTAP.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnLocationFSxONTAP
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 CfnLocationFSxONTAP : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLocationFSxONTAP
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system. AWS DataSync can access this endpoint as a source or destination location.

CloudformationResource: AWS::DataSync::LocationFSxONTAP

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.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;

CfnLocationFSxONTAP cfnLocationFSxONTAP = new CfnLocationFSxONTAP(this, "MyCfnLocationFSxONTAP", new CfnLocationFSxONTAPProps {
    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"
        }
    },
    SecurityGroupArns = new [] { "securityGroupArns" },
    StorageVirtualMachineArn = "storageVirtualMachineArn",

    // the properties below are optional
    Subdirectory = "subdirectory",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnLocationFSxONTAP(Construct, String, ICfnLocationFSxONTAPProps)

Create a new AWS::DataSync::LocationFSxONTAP.

CfnLocationFSxONTAP(ByRefValue)

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

CfnLocationFSxONTAP(DeputyBase.DeputyProps)

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

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
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'll copy your data.

Tags

Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

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 System.String
  • scoped id of the resource.
props ICfnLocationFSxONTAPProps
  • resource properties.

CfnLocationFSxONTAP(ByRefValue)

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

protected CfnLocationFSxONTAP(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnLocationFSxONTAP(DeputyBase.DeputyProps)

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

protected CfnLocationFSxONTAP(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrFsxFilesystemArn

The ARN of the FSx for ONTAP file system in the specified location.

public virtual string AttrFsxFilesystemArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: FsxFilesystemArn

AttrLocationArn

The ARN of the specified location.

public virtual string AttrLocationArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified 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

Protocol

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

public virtual object Protocol { get; set; }
Property Value

System.Object

Remarks

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

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

System.String[]

Remarks

You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):

    Your file system's security groups must also allow inbound traffic on the same port.

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

    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

    System.String

    Remarks

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

    Subdirectory

    Specifies a path to the file share in the SVM where you'll copy your data.

    public virtual string Subdirectory { get; set; }
    Property Value

    System.String

    Remarks

    You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1 , /vol1/tree1 , or /share1 .

    Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide .

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

    Tags

    Specifies labels that help you categorize, filter, and search for your AWS resources.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    We recommend creating at least a name tag for your location.

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

    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
    Back to top Generated by DocFX