software.amazon.awscdk.services.datasync

Class CfnLocationEFS

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datasync.CfnLocationEFS

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.862Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationEFS(software.constructs.Construct scope, 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
String	getAccessPointArn() `AWS::DataSync::LocationEFS.AccessPointArn`.
String	getAttrLocationArn() The Amazon Resource Name (ARN) of the Amazon EFS file system.
String	getAttrLocationUri() The URI of the Amazon EFS file system.
protected Map<String,Object>	getCfnProperties()
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.
String	getFileSystemAccessRoleArn() `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
String	getInTransitEncryption() `AWS::DataSync::LocationEFS.InTransitEncryption`.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPointArn(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(String value) The Amazon Resource Name (ARN) for the Amazon EFS file system.
void	setFileSystemAccessRoleArn(String value) `AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
void	setInTransitEncryption(String value) `AWS::DataSync::LocationEFS.InTransitEncryption`.
void	setSubdirectory(String value) A subdirectory in the location’s path.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnLocationEFS(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLocationArn

@Stability(value=Stable)
 @NotNull
public String getAttrLocationArn()

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

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the Amazon EFS file system.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setEc2Config(@NotNull
                                                  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

@Stability(value=Stable)
public void setEc2Config(@NotNull
                                                  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

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

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

setEfsFilesystemArn

@Stability(value=Stable)
public void setEfsFilesystemArn(@NotNull
                                                         String value)

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

getAccessPointArn

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

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

setAccessPointArn

@Stability(value=Stable)
public void setAccessPointArn(@Nullable
                                                       String value)

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

getFileSystemAccessRoleArn

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

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

setFileSystemAccessRoleArn

@Stability(value=Stable)
public void setFileSystemAccessRoleArn(@Nullable
                                                                String value)

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

getInTransitEncryption

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

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

setInTransitEncryption

@Stability(value=Stable)
public void setInTransitEncryption(@Nullable
                                                            String value)

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

getSubdirectory

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSubdirectory(@Nullable
                                                     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 .