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[Ec2ConfigProperty, Dict[str, Any], IResolvable]) – Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

  • access_point_arn (Optional[str]) – Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

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

  • file_system_access_role_arn (Optional[str]) – Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

  • in_transit_encryption (Optional[str]) – 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 .

  • 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). By default, DataSync uses the root directory, but you can also include subdirectories. .. epigraph:: You must specify a value with 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.

Link:

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.
import aws_cdk.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 access the Amazon EFS file system.

Link:

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

ec2_config

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

Link:

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

efs_filesystem_arn

Specifies the ARN for the Amazon EFS file system.

Link:

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 DataSync assumes when mounting the Amazon EFS file system.

Link:

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

Link:

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). By default, DataSync uses the root directory, but you can also include subdirectories. .. epigraph:

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

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.

Link:

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