Class CfnLocationEFS
A CloudFormation AWS::DataSync::LocationEFS
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnLocationEFS : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLocationEFS
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DataSync::LocationEFS
resource creates an endpoint for an Amazon EFS file system. AWS DataSync can access this endpoint as a source or destination 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;
var cfnLocationEFS = new CfnLocationEFS(this, "MyCfnLocationEFS", 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
Constructors
CfnLocationEFS(Construct, String, ICfnLocationEFSProps) | Create a new |
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
AccessPointArn | Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system. |
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 | Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system. |
EfsFilesystemArn | Specifies the ARN for the Amazon EFS file system. |
FileSystemAccessRoleArn | Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system. |
InTransitEncryption | Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the 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. |
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
AccessPointArn
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
public virtual string AccessPointArn { get; set; }
Property Value
System.String
Remarks
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
Ec2Config
Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
public virtual object Ec2Config { get; set; }
Property Value
System.Object
Remarks
EfsFilesystemArn
Specifies the ARN for the Amazon EFS file system.
public virtual string EfsFilesystemArn { get; set; }
Property Value
System.String
Remarks
FileSystemAccessRoleArn
Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
public virtual string FileSystemAccessRoleArn { get; set; }
Property Value
System.String
Remarks
InTransitEncryption
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
public virtual string InTransitEncryption { get; set; }
Property Value
System.String
Remarks
If you specify an access point using AccessPointArn
or an IAM role using FileSystemAccessRoleArn
, you must set this parameter to TLS1_2
.
Subdirectory
Specifies a mount path for your Amazon EFS file system.
public virtual string Subdirectory { get; set; }
Property Value
System.String
Remarks
This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.
You must specify a value with forward slashes (for example, /path/to/folder
).
Tags
Specifies the key-value pair that represents a tag that you want to add to the resource.
public virtual TagManager Tags { get; }
Property Value
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.
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>