Skip to content

FsxUpdateProtocolSmb

Source code in docs_src/capo_datasync/types/fsx_update_protocol_smb.py
class FsxUpdateProtocolSmb(TypedDict, closed=True):
    domain: NotRequired["capo_datasync.types.update_smb_domain.UpdateSmbDomain"]
    """<p>Specifies the name of the Windows domain that your storage virtual machine (SVM) 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 SVM.</p>"""
    mount_options: NotRequired["capo_datasync.types.smb_mount_options.SmbMountOptions"]
    password: NotRequired["capo_datasync.types.smb_password.SmbPassword"]
    """<p>Specifies the password of a user who has permission to access your SVM.</p>"""
    user: NotRequired["capo_datasync.types.smb_user.SmbUser"]
    """<p>Specifies a user that can mount and access the files, folders, and metadata in your SVM.</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-ontap-location.html#create-ontap-location-smb">Using the SMB protocol</a>.</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. This configuration includes the secret ARN, and the ARN for an 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. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

domain instance-attribute

domain: NotRequired[UpdateSmbDomain]

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

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

mount_options instance-attribute

mount_options: NotRequired[SmbMountOptions]

password instance-attribute

password: NotRequired[SmbPassword]

Specifies the password of a user who has permission to access your SVM.

user instance-attribute

user: NotRequired[SmbUser]

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.