software.amazon.awscdk.services.datasync

Interface CfnLocationEFSProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationEFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.864Z")
 @Stability(value=Stable)
public interface CfnLocationEFSProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLocationEFS`.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLocationEFSProps.Builder	builder()
default String	getAccessPointArn() `AWS::DataSync::LocationEFS.AccessPointArn`.
Object	getEc2Config() The subnet and security group that the Amazon EFS file system uses.
String	getEfsFilesystemArn() The Amazon Resource Name (ARN) for the Amazon EFS file system.
default String	getFileSystemAccessRoleArn() `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
default String	getInTransitEncryption() `AWS::DataSync::LocationEFS.InTransitEncryption`.
default String	getSubdirectory() A subdirectory in the location’s path.
default List<CfnTag>	getTags() 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 Detail

getEc2Config

@Stability(value=Stable)
 @NotNull
Object getEc2Config()

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

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:

• Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.
• Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.

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

getEfsFilesystemArn

@Stability(value=Stable)
 @NotNull
String getEfsFilesystemArn()

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

getAccessPointArn

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

`AWS::DataSync::LocationEFS.AccessPointArn`.

getFileSystemAccessRoleArn

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

`AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.

getInTransitEncryption

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

`AWS::DataSync::LocationEFS.InTransitEncryption`.

getSubdirectory

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

A subdirectory in the location’s path.

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 .

getTags

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

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.

builder

@Stability(value=Stable)
static CfnLocationEFSProps.Builder builder()

Returns:

a CfnLocationEFSProps.Builder of CfnLocationEFSProps