software.amazon.awscdk.services.datasync

Class CfnLocationEFS.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationEFS.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationEFS>

Enclosing class:

CfnLocationEFS

@Stability(value=Stable)
public static final class CfnLocationEFS.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationEFS>

A fluent builder for CfnLocationEFS.

Method Summary

Modifier and Type	Method and Description
CfnLocationEFS.Builder	accessPointArn(String accessPointArn) `AWS::DataSync::LocationEFS.AccessPointArn`.
CfnLocationEFS	build()
static CfnLocationEFS.Builder	create(software.constructs.Construct scope, String id)
CfnLocationEFS.Builder	ec2Config(CfnLocationEFS.Ec2ConfigProperty ec2Config) The subnet and security group that the Amazon EFS file system uses.
CfnLocationEFS.Builder	ec2Config(IResolvable ec2Config) The subnet and security group that the Amazon EFS file system uses.
CfnLocationEFS.Builder	efsFilesystemArn(String efsFilesystemArn) The Amazon Resource Name (ARN) for the Amazon EFS file system.
CfnLocationEFS.Builder	fileSystemAccessRoleArn(String fileSystemAccessRoleArn) `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
CfnLocationEFS.Builder	inTransitEncryption(String inTransitEncryption) `AWS::DataSync::LocationEFS.InTransitEncryption`.
CfnLocationEFS.Builder	subdirectory(String subdirectory) A subdirectory in the location’s path.
CfnLocationEFS.Builder	tags(List<? extends CfnTag> tags) The key-value pair that represents a tag that you want to add to the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnLocationEFS.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLocationEFS.Ec2ConfigProperty.Builder.

ec2Config

@Stability(value=Stable)
public CfnLocationEFS.Builder ec2Config(CfnLocationEFS.Ec2ConfigProperty ec2Config)

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.

Parameters:

ec2Config - The subnet and security group that the Amazon EFS file system uses. This parameter is required.

Returns:

this

ec2Config

@Stability(value=Stable)
public CfnLocationEFS.Builder ec2Config(IResolvable ec2Config)

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.

Parameters:

ec2Config - The subnet and security group that the Amazon EFS file system uses. This parameter is required.

Returns:

this

efsFilesystemArn

@Stability(value=Stable)
public CfnLocationEFS.Builder efsFilesystemArn(String efsFilesystemArn)

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

Parameters:

efsFilesystemArn - The Amazon Resource Name (ARN) for the Amazon EFS file system. This parameter is required.

Returns:

this

accessPointArn

@Stability(value=Stable)
public CfnLocationEFS.Builder accessPointArn(String accessPointArn)

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

Parameters:

accessPointArn - `AWS::DataSync::LocationEFS.AccessPointArn`. This parameter is required.

Returns:

this

fileSystemAccessRoleArn

@Stability(value=Stable)
public CfnLocationEFS.Builder fileSystemAccessRoleArn(String fileSystemAccessRoleArn)

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

Parameters:

fileSystemAccessRoleArn - `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`. This parameter is required.

Returns:

this

inTransitEncryption

@Stability(value=Stable)
public CfnLocationEFS.Builder inTransitEncryption(String inTransitEncryption)

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

Parameters:

inTransitEncryption - `AWS::DataSync::LocationEFS.InTransitEncryption`. This parameter is required.

Returns:

this

subdirectory

@Stability(value=Stable)
public CfnLocationEFS.Builder subdirectory(String subdirectory)

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 .

Parameters:

subdirectory - A subdirectory in the location’s path. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnLocationEFS.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - The key-value pair that represents a tag that you want to add to the resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnLocationEFS build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationEFS>