MDAA TS Docs
    Preparing search index...

    Interface LocationSmbProps

    SMB file share location configuration for DataSync transfers from on-premises Windows file servers or NAS devices. Credentials (user/password) must be pre-stored in a Secrets Manager secret in the format: {"user":"","password":""}. If secretName is omitted, MDAA creates an empty secret to populate after deployment.

    Use cases: Windows file share migration to S3; On-premises NAS data transfer; SMB protocol synchronization

    AWS: DataSync LocationSMB resource (CfnLocationSMB)

    Validation: serverHostname, subdirectory, and secretName required; one of agentNames or agentArns required (mutually exclusive)

    interface LocationSmbProps {
        agentArns?: string[];
        agentNames?: string[];
        domain?: string;
        secretName: string;
        serverHostname: string;
        smbVersion?: SmbVersion;
        subdirectory: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agentArns? agentNames? domain? secretName serverHostname smbVersion? subdirectory

    Properties

    agentArns?: string[]

    ARNs of DataSync agents for SMB connectivity. Use when agents are registered outside MDAA. Mutually exclusive with agentNames.

    Use cases: Externally managed agent references; Pre-existing agent reuse

    AWS: DataSync agent ARNs for SMB location configuration

    Validation: Optional; mutually exclusive with agentNames; must be valid DataSync agent ARNs

    agentNames?: string[]

    Names of MDAA-generated DataSync agents from the agents config section. Resolved to agent ARNs automatically. Only one agent is accepted for SMB locations. Mutually exclusive with agentArns.

    Use cases: Referencing MDAA-managed agents by name; Simplified agent configuration

    AWS: Resolved to DataSync agent ARNs for SMB location onPremConfig

    Validation: Optional; mutually exclusive with agentArns; list accepts one member for SMB

    domain?: string

    Windows Active Directory domain name for domain-based SMB authentication.

    Use cases: Domain-joined SMB server authentication; Enterprise AD integration

    AWS: Windows domain for SMB server authentication

    Validation: Optional; must be valid Windows domain name if specified

    secretName: string

    Secrets Manager secret name storing SMB credentials. Secret must contain "user" and "password" fields: {"user":"","password":""}. If omitted, MDAA creates an empty secret to populate after deployment.

    Use cases: SMB authentication; Secure credential management for Windows file shares

    AWS: Secrets Manager secret for SMB file share authentication

    Validation: Required; secret must contain user and password fields

    serverHostname: string

    Hostname or IP address of the SMB server. The on-premises DataSync agent uses this to mount the SMB share.

    Use cases: SMB server identification; On-premises file server connectivity

    AWS: SMB server hostname for DataSync agent mounting

    Validation: Required; must be valid DNS name or IPv4 address

    smbVersion?: SmbVersion

    SMB protocol version for mount options. MDAA custom parameter — the value is used to construct the MountOptions object.

    Use cases: SMB protocol version control; Compatibility with older SMB servers

    AWS: SMB mount options version for DataSync location

    Validation: Optional; valid values: AUTOMATIC | SMB2 | SMB3

    AUTOMATIC
    subdirectory: string

    SMB share subdirectory path for data access. Must use forward slashes (e.g. /path/to/folder). The user specified in credentials must have read/write permissions and execute access on directories.

    Use cases: Scoped SMB share access; Subdirectory-level data transfer

    AWS: SMB subdirectory path for DataSync location

    Validation: Required; must use forward slash format

    Settings

    Member Visibility

    On This Page

    Properties