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.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.742Z")
public class CfnLocationEFS
extends CfnResource
implements IInspectable

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

The AWS::DataSync::LocationEFS resource creates an endpoint for an Amazon EFS file system. AWS DataSync can access this endpoint as a source or destination 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())
         // the properties below are optional
         .accessPointArn("accessPointArn")
         .efsFilesystemArn("efsFilesystemArn")
         .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 security groups that AWS DataSync uses to access your Amazon 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() Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
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() Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
java.lang.String	getEfsFilesystemArn() Specifies the ARN for the Amazon EFS file system.
java.lang.String	getFileSystemAccessRoleArn() Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
java.lang.String	getInTransitEncryption() Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
java.lang.String	getSubdirectory() Specifies a mount path for your Amazon EFS file system.
TagManager	getTags() Specifies 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) Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
void	setEc2Config(CfnLocationEFS.Ec2ConfigProperty value) Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
void	setEc2Config(IResolvable value) Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
void	setEfsFilesystemArn(java.lang.String value) Specifies the ARN for the Amazon EFS file system.
void	setFileSystemAccessRoleArn(java.lang.String value) Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
void	setInTransitEncryption(java.lang.String value) Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
void	setSubdirectory(java.lang.String value) Specifies a mount path for your Amazon EFS file system.

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()

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.

getEc2Config

public java.lang.Object getEc2Config()

Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

setEc2Config

public void setEc2Config(CfnLocationEFS.Ec2ConfigProperty value)

Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

setEc2Config

public void setEc2Config(IResolvable value)

Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

getAccessPointArn

public java.lang.String getAccessPointArn()

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

setAccessPointArn

public void setAccessPointArn(java.lang.String value)

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

getEfsFilesystemArn

public java.lang.String getEfsFilesystemArn()

Specifies the ARN for the Amazon EFS file system.

setEfsFilesystemArn

public void setEfsFilesystemArn(java.lang.String value)

Specifies the ARN for the Amazon EFS file system.

getFileSystemAccessRoleArn

public java.lang.String getFileSystemAccessRoleArn()

Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

setFileSystemAccessRoleArn

public void setFileSystemAccessRoleArn(java.lang.String value)

Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

getInTransitEncryption

public java.lang.String getInTransitEncryption()

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the 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 .

setInTransitEncryption

public void setInTransitEncryption(java.lang.String value)

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the 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 .

getSubdirectory

public java.lang.String getSubdirectory()

Specifies a mount path for your Amazon EFS file system.

This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

You must specify a value with forward slashes (for example, /path/to/folder ).

setSubdirectory

public void setSubdirectory(java.lang.String value)

Specifies a mount path for your Amazon EFS file system.

This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

You must specify a value with forward slashes (for example, /path/to/folder ).