CfnLocationEFSProps

class aws_cdk.aws_datasync.CfnLocationEFSProps(*, ec2_config, access_point_arn=None, efs_filesystem_arn=None, file_system_access_role_arn=None, in_transit_encryption=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationEFS.

Parameters:

  • ec2_config (Union[IResolvable, Ec2ConfigProperty, Dict[str, Any]]) – Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system’s mount targets .

  • access_point_arn (Optional[str]) – Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system. For more information, see Accessing restricted file systems .

  • efs_filesystem_arn (Optional[str]) – Specifies the ARN for your Amazon EFS file system.

  • file_system_access_role_arn (Optional[str]) – Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system. For information on creating this role, see Creating a DataSync IAM role for file system access .

  • in_transit_encryption (Optional[str]) – Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your 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 .

  • subdirectory (Optional[str]) – 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) on your file system. By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn ). You can also include subdirectories using forward slashes (for example, /path/to/folder ).

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_eFSProps = datasync.CfnLocationEFSProps(
    ec2_config=datasync.CfnLocationEFS.Ec2ConfigProperty(
        security_group_arns=["securityGroupArns"],
        subnet_arn="subnetArn"
    ),

    # the properties below are optional
    access_point_arn="accessPointArn",
    efs_filesystem_arn="efsFilesystemArn",
    file_system_access_role_arn="fileSystemAccessRoleArn",
    in_transit_encryption="inTransitEncryption",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

access_point_arn

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

For more information, see Accessing restricted file systems .

See:

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

ec2_config

//docs.aws.amazon.com/efs/latest/ug/accessing-fs.html>`_ .

See:

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

Type:

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system’s `mount targets <https

efs_filesystem_arn

Specifies the ARN for your Amazon EFS file system.

See:

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

file_system_access_role_arn

Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For information on creating this role, see Creating a DataSync IAM role for file system access .

See:

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

in_transit_encryption

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

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

subdirectory

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) on your file system.

By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn ). You can also include subdirectories using forward slashes (for example, /path/to/folder ).

See:

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

tags

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:

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