Class CfnLocationEFS

A CloudFormation AWS::DataSync::LocationEFS.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnLocationEFS

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 CfnLocationEFS : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

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

Remarks

The AWS::DataSync::LocationEFS resource specifies an endpoint for an Amazon EFS location.

CloudformationResource: AWS::DataSync::LocationEFS

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

CfnLocationEFS cfnLocationEFS = new CfnLocationEFS(this, "MyCfnLocationEFS", new CfnLocationEFSProps {
    Ec2Config = new Ec2ConfigProperty {
        SecurityGroupArns = new [] { "securityGroupArns" },
        SubnetArn = "subnetArn"
    },
    EfsFilesystemArn = "efsFilesystemArn",

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

Synopsis

Constructors

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

Properties

AttrLocationArn	The Amazon Resource Name (ARN) of the Amazon EFS file system.
AttrLocationUri	The URI of the Amazon EFS file system.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Ec2Config	The subnet and security group that the Amazon EFS file system uses.
EfsFilesystemArn	The Amazon Resource Name (ARN) for the Amazon EFS file system.
Subdirectory	A subdirectory in the location’s path.
Tags	The key-value pair that represents a tag that you want to add to the resource.

Methods

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

Constructors

CfnLocationEFS(Construct, String, ICfnLocationEFSProps)

Create a new AWS::DataSync::LocationEFS.

public CfnLocationEFS(Construct scope, string id, ICfnLocationEFSProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnLocationEFSProps

resource properties.

CfnLocationEFS(ByRefValue)

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

protected CfnLocationEFS(ByRefValue reference)

Parameters

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

CfnLocationEFS(DeputyBase.DeputyProps)

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

protected CfnLocationEFS(DeputyBase.DeputyProps props)

Parameters

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

Properties

AttrLocationArn

The Amazon Resource Name (ARN) of the Amazon EFS file system.

public virtual string AttrLocationArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the Amazon EFS file system.

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

Ec2Config

The subnet and security group that the Amazon EFS file system uses.

public virtual object Ec2Config { get; set; }

Property Value

System.Object

Remarks

The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.

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

EfsFilesystemArn

The Amazon Resource Name (ARN) for the Amazon EFS file system.

public virtual string EfsFilesystemArn { get; set; }

Property Value

System.String

Remarks

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

Subdirectory

A subdirectory in the location’s path.

public virtual string Subdirectory { get; set; }

Property Value

System.String

Remarks

This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.

Subdirectory must be specified with forward slashes. For example, /path/to/folder .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-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