Skip to content

UpdateLocationEfsRequest

Source code in docs_src/capo_datasync/types/update_location_efs_request.py
class UpdateLocationEfsRequest(TypedDict, closed=True):
    location_arn: "capo_datasync.types.location_arn.LocationArn"
    """<p>Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.</p>"""
    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>"""
    access_point_arn: NotRequired[
        "capo_datasync.types.updated_efs_access_point_arn.UpdatedEfsAccessPointArn"
    ]
    """<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 Amazon EFS file systems</a>.</p>"""
    file_system_access_role_arn: NotRequired[
        "capo_datasync.types.updated_efs_iam_role_arn.UpdatedEfsIamRoleArn"
    ]
    """<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 Amazon EFS 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[UpdatedEfsAccessPointArn]

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 Amazon EFS file systems.

file_system_access_role_arn instance-attribute

file_system_access_role_arn: NotRequired[UpdatedEfsIamRoleArn]

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

location_arn instance-attribute

location_arn: LocationArn

Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.

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