Show / Hide Table of Contents

Interface ICfnLocationEFSProps

Properties for defining a CfnLocationEFS.

Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnLocationEFSProps
Syntax (vb)
Public Interface ICfnLocationEFSProps
Remarks

See: 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;

             var cfnLocationEFSProps = new CfnLocationEFSProps {
                 Ec2Config = new Ec2ConfigProperty {
                     SecurityGroupArns = new [] { "securityGroupArns" },
                     SubnetArn = "subnetArn"
                 },

                 // the properties below are optional
                 AccessPointArn = "accessPointArn",
                 EfsFilesystemArn = "efsFilesystemArn",
                 FileSystemAccessRoleArn = "fileSystemAccessRoleArn",
                 InTransitEncryption = "inTransitEncryption",
                 Subdirectory = "subdirectory",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

AccessPointArn

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

Ec2Config

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets .

EfsFilesystemArn

Specifies the ARN for your Amazon EFS file system.

FileSystemAccessRoleArn

Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

InTransitEncryption

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

Subdirectory

Specifies a mount path for your Amazon EFS file system.

Tags

Specifies the key-value pair that represents a tag that you want to add to the resource.

Properties

AccessPointArn

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

string? AccessPointArn { get; }
Property Value

string

Remarks

For more information, see Accessing restricted file systems .

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

Ec2Config

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets .

object Ec2Config { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnLocationEFS.IEc2ConfigProperty

EfsFilesystemArn

Specifies the ARN for your Amazon EFS file system.

object? EfsFilesystemArn { get; }
Property Value

object

Remarks

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

Type union: either string or IFileSystemRef

FileSystemAccessRoleArn

Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

string? FileSystemAccessRoleArn { get; }
Property Value

string

Remarks

For information on creating this role, see Creating a DataSync IAM role for file system access .

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

InTransitEncryption

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

string? InTransitEncryption { get; }
Property Value

string

Remarks

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn , you must set this parameter to TLS1_2 .

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

Subdirectory

Specifies a mount path for your Amazon EFS file system.

string? Subdirectory { get; }
Property Value

string

Remarks

This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn ). You can also include subdirectories using forward slashes (for example, /path/to/folder ).

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

Tags

Specifies the key-value pair that represents a tag that you want to add to the resource.

ICfnTag[]? Tags { get; }
Property Value

ICfnTag[]

Remarks

The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

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

Back to top Generated by DocFX