Skip to content

CreateLocationEfsRequest

Source code in docs_src/capo_datasync/types/create_location_efs_request.py
class CreateLocationEfsRequest(TypedDict, closed=True):
    subdirectory: NotRequired["capo_datasync.types.efs_subdirectory.EfsSubdirectory"]
    """<p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).</p> <p>By default, DataSync uses the root directory (or <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">access point</a> if you provide one by using <code>AccessPointArn</code>). You can also include subdirectories using forward slashes (for example, <code>/path/to/folder</code>).</p>"""
    efs_filesystem_arn: "capo_datasync.types.efs_filesystem_arn.EfsFilesystemArn"
    """<p>Specifies the ARN for your Amazon EFS file system.</p>"""
    ec2_config: "capo_datasync.types.ec2_config.Ec2Config"
    """<p>Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's <a href="https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html">mount targets</a>.</p>"""
    tags: NotRequired["capo_datasync.types.input_tag_list.InputTagList"]
    """<p>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.</p>"""
    access_point_arn: NotRequired[
        "capo_datasync.types.efs_access_point_arn.EfsAccessPointArn"
    ]
    """<p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing restricted file systems</a>.</p>"""
    file_system_access_role_arn: NotRequired[
        "capo_datasync.types.iam_role_arn.IamRoleArn"
    ]
    """<p>Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.</p> <p>For information on creating this role, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync IAM role for file system access</a>.</p>"""
    in_transit_encryption: NotRequired[
        "capo_datasync.types.efs_in_transit_encryption.EfsInTransitEncryption"
    ]
    """<p>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.</p> <p>If you specify an access point using <code>AccessPointArn</code> or an IAM role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to <code>TLS1_2</code>.</p>"""

access_point_arn instance-attribute

access_point_arn: NotRequired[EfsAccessPointArn]

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.

ec2_config instance-attribute

ec2_config: Ec2Config

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets.

efs_filesystem_arn instance-attribute

efs_filesystem_arn: EfsFilesystemArn

Specifies the ARN for your Amazon EFS file system.

file_system_access_role_arn instance-attribute

file_system_access_role_arn: NotRequired[IamRoleArn]

Specifies an 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 instance-attribute

in_transit_encryption: NotRequired[EfsInTransitEncryption]

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 instance-attribute

subdirectory: NotRequired[EfsSubdirectory]

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

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 instance-attribute

tags: NotRequired[InputTagList]

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.