software.amazon.awscdk.services.datasync

Class CfnLocationEFS

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.datasync.CfnLocationEFS

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.431Z")
public class CfnLocationEFS
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationEFS`.

The AWS::DataSync::LocationEFS resource specifies an endpoint for an Amazon EFS location.

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.*;
 CfnLocationEFS cfnLocationEFS = CfnLocationEFS.Builder.create(this, "MyCfnLocationEFS")
         .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	Class and Description
static class	CfnLocationEFS.Builder A fluent builder for CfnLocationEFS.
static interface	CfnLocationEFS.Ec2ConfigProperty The subnet and the security group that DataSync uses to access the target EFS file system.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationEFS(Construct scope, java.lang.String id, CfnLocationEFSProps props) Create a new `AWS::DataSync::LocationEFS`.
protected	CfnLocationEFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationEFS(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessPointArn() `AWS::DataSync::LocationEFS.AccessPointArn`.
java.lang.String	getAttrLocationArn() The Amazon Resource Name (ARN) of the Amazon EFS file system.
java.lang.String	getAttrLocationUri() The URI of the Amazon EFS file system.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getEc2Config() The subnet and security group that the Amazon EFS file system uses.
java.lang.String	getEfsFilesystemArn() The Amazon Resource Name (ARN) for the Amazon EFS file system.
java.lang.String	getFileSystemAccessRoleArn() `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
java.lang.String	getInTransitEncryption() `AWS::DataSync::LocationEFS.InTransitEncryption`.
java.lang.String	getSubdirectory() A subdirectory in the location’s path.
TagManager	getTags() The key-value pair that represents a tag that you want to add to the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccessPointArn(java.lang.String value) `AWS::DataSync::LocationEFS.AccessPointArn`.
void	setEc2Config(CfnLocationEFS.Ec2ConfigProperty value) The subnet and security group that the Amazon EFS file system uses.
void	setEc2Config(IResolvable value) The subnet and security group that the Amazon EFS file system uses.
void	setEfsFilesystemArn(java.lang.String value) The Amazon Resource Name (ARN) for the Amazon EFS file system.
void	setFileSystemAccessRoleArn(java.lang.String value) `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
void	setInTransitEncryption(java.lang.String value) `AWS::DataSync::LocationEFS.InTransitEncryption`.
void	setSubdirectory(java.lang.String value) A subdirectory in the location’s path.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationEFS

protected CfnLocationEFS(software.amazon.jsii.JsiiObjectRef objRef)

CfnLocationEFS

protected CfnLocationEFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLocationEFS

public CfnLocationEFS(Construct scope,
                      java.lang.String id,
                      CfnLocationEFSProps props)

Create a new `AWS::DataSync::LocationEFS`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLocationArn

public java.lang.String getAttrLocationArn()

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

getAttrLocationUri

public java.lang.String getAttrLocationUri()

The URI of the Amazon EFS file system.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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.

getEc2Config

public java.lang.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.

setEc2Config

public void setEc2Config(CfnLocationEFS.Ec2ConfigProperty value)

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.

setEc2Config

public void setEc2Config(IResolvable value)

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

public java.lang.String getEfsFilesystemArn()

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

setEfsFilesystemArn

public void setEfsFilesystemArn(java.lang.String value)

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

getAccessPointArn

public java.lang.String getAccessPointArn()

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

setAccessPointArn

public void setAccessPointArn(java.lang.String value)

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

getFileSystemAccessRoleArn

public java.lang.String getFileSystemAccessRoleArn()

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

setFileSystemAccessRoleArn

public void setFileSystemAccessRoleArn(java.lang.String value)

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

getInTransitEncryption

public java.lang.String getInTransitEncryption()

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

setInTransitEncryption

public void setInTransitEncryption(java.lang.String value)

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

getSubdirectory

public java.lang.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 .

setSubdirectory

public void setSubdirectory(java.lang.String value)

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 .