Skip to content

UpdateLocationFsxWindowsRequest

Source code in docs_src/capo_datasync/types/update_location_fsx_windows_request.py
class UpdateLocationFsxWindowsRequest(TypedDict, closed=True):
    location_arn: "capo_datasync.types.location_arn.LocationArn"
    """<p>Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.</p>"""
    subdirectory: NotRequired[
        "capo_datasync.types.fsx_windows_subdirectory.FsxWindowsSubdirectory"
    ]
    """<p>Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).</p>"""
    domain: NotRequired["capo_datasync.types.update_smb_domain.UpdateSmbDomain"]
    """<p>Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.</p>"""
    user: NotRequired["capo_datasync.types.smb_user.SmbUser"]
    """<p>Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>"""
    password: NotRequired["capo_datasync.types.smb_password.SmbPassword"]
    """<p>Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p>"""
    cmk_secret_config: NotRequired[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ]
    """<p>Specifies configuration information for a DataSync-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p>"""
    custom_secret_config: NotRequired[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ]
    """<p>Specifies configuration information for a customer-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.</p>"""

cmk_secret_config instance-attribute

cmk_secret_config: NotRequired[CmkSecretConfig]

Specifies configuration information for a DataSync-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

custom_secret_config instance-attribute

custom_secret_config: NotRequired[CustomSecretConfig]

Specifies configuration information for a customer-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

domain instance-attribute

domain: NotRequired[UpdateSmbDomain]

Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

location_arn instance-attribute

location_arn: LocationArn

Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.

password instance-attribute

password: NotRequired[SmbPassword]

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

subdirectory instance-attribute

subdirectory: NotRequired[FsxWindowsSubdirectory]

Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

user instance-attribute

user: NotRequired[SmbUser]

Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.