Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Interface CfnLocationEFSMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationEFSMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.845Z")
@Stability(Stable)
public interface CfnLocationEFSMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnLocationEFSPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.datasync.*;
 CfnLocationEFSMixinProps cfnLocationEFSMixinProps = CfnLocationEFSMixinProps.builder()
         .accessPointArn("accessPointArn")
         .ec2Config(Ec2ConfigProperty.builder()
                 .securityGroupArns(List.of("securityGroupArns"))
                 .subnetArn("subnetArn")
                 .build())
         .efsFilesystemArn("efsFilesystemArn")
         .fileSystemAccessRoleArn("fileSystemAccessRoleArn")
         .inTransitEncryption("inTransitEncryption")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationEFSMixinProps.Builder	A builder for CfnLocationEFSMixinProps
static final class	CfnLocationEFSMixinProps.Jsii$Proxy	An implementation for CfnLocationEFSMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnLocationEFSMixinProps.Builder	builder()
default String	getAccessPointArn()	Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.
default Object	getEc2Config()	Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets .
default Object	getEfsFilesystemArn()	Specifies the ARN for your Amazon EFS file system.
default String	getFileSystemAccessRoleArn()	Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
default String	getInTransitEncryption()	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.
default String	getSubdirectory()	Specifies a mount path for your Amazon EFS file system.
default List<CfnTag>	getTags()	Specifies the key-value pair that represents a tag that you want to add to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessPointArn

@Stability(Stable)
@Nullable
default String getAccessPointArn()

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

For more information, see Accessing restricted file systems .

See Also:

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

getEc2Config

@Stability(Stable)
@Nullable
default Object getEc2Config()

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

Returns union: either IResolvable or CfnLocationEFSPropsMixin.Ec2ConfigProperty

See Also:

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

getEfsFilesystemArn

@Stability(Stable)
@Nullable
default Object getEfsFilesystemArn()

Specifies the ARN for your Amazon EFS file system.

Returns union: either String or IFileSystemRef

See Also:

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

getFileSystemAccessRoleArn

@Stability(Stable)
@Nullable
default String getFileSystemAccessRoleArn()

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

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

See Also:

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

getInTransitEncryption

@Stability(Stable)
@Nullable
default String getInTransitEncryption()

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.

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

See Also:

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

getSubdirectory

@Stability(Stable)
@Nullable
default String getSubdirectory()

Specifies a mount path for your Amazon EFS file system.

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 Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

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 Also:

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

builder

@Stability(Stable)
static CfnLocationEFSMixinProps.Builder builder()

Returns:

a CfnLocationEFSMixinProps.Builder of CfnLocationEFSMixinProps