Package 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.102.0 (build e354887)",
           date="2024-08-23T05:56:14.293Z")
@Stability(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())
         // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLocationEFSProps.Builder	builder()
default String	getAccessPointArn()	Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
Object	getEc2Config()	Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
default String	getEfsFilesystemArn()	Specifies the ARN for the Amazon EFS file system.
default String	getFileSystemAccessRoleArn()	Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
default 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.
default String	getSubdirectory()	Specifies a mount path for your Amazon EFS file system.
default List<CfnTag>	getTags()	Specifies 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 Details

getEc2Config

@Stability(Stable)
@NotNull
Object getEc2Config()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-ec2config

getAccessPointArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-accesspointarn

getEfsFilesystemArn

@Stability(Stable)
@Nullable
default String getEfsFilesystemArn()

Specifies the ARN for the Amazon EFS file system.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-efsfilesystemarn

getFileSystemAccessRoleArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-filesystemaccessrolearn

getInTransitEncryption

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-intransitencryption

getSubdirectory

@Stability(Stable)
@Nullable
default 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 ).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-subdirectory

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-tags

builder

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

Returns:

a CfnLocationEFSProps.Builder of CfnLocationEFSProps