MDAA TS Docs
    Preparing search index...

    Interface ServerProps

    Transfer Family SFTP server configuration for secure file transfer to S3. MDAA creates a security group allowing port 22 ingress from specified CIDRs, deploys the server on specified VPC/subnets, and optionally allocates a public IP.

    Use cases: B2B file exchange; Secure data ingestion from partners; Legacy system integration

    AWS: Transfer Family SFTP server with VPC endpoint, security group, and CloudWatch logging

    Validation: vpcId, subnetIds, and ingressCidrs required

    interface ServerProps {
        ingressCidrs: string[];
        internetFacing?: boolean;
        securityPolicyName?: string;
        subnetIds: string[];
        vpcId: string;
    }
    Index

    Properties

    ingressCidrs internetFacing? securityPolicyName? subnetIds vpcId

    Properties

    ingressCidrs: string[]

    CIDR blocks permitted to connect to the SFTP server on port 22. All other ingress is denied by default.

    Use cases: IP-based access control; Partner network whitelisting

    AWS: Security group ingress rules for Transfer Family server (TCP 22)

    Validation: Required; array of valid CIDR blocks (e.g. 10.0.0.0/8)

    internetFacing?: boolean

    Whether to allocate a public Elastic IP for internet-facing access. When false, the server is only accessible within the VPC.

    Use cases: External partner file uploads; Internet-accessible SFTP endpoint

    AWS: Elastic IP allocation for Transfer Family public endpoint

    Validation: Optional; boolean

    false
    securityPolicyName?: string

    Optional Transfer Family security policy name controlling cryptographic algorithms for SFTP connections. Defaults to 'TransferSecurityPolicy-FIPS-2020-06' for backwards compatibility. Use a non-FIPS policy (e.g. 'TransferSecurityPolicy-2024-01') in regions that do not support FIPS.

    subnetIds: string[]

    Subnet IDs where the SFTP server will have network interfaces. Use multiple subnets across AZs for high availability.

    Use cases: Multi-AZ SFTP deployment; Network segmentation

    AWS: VPC subnets for Transfer Family server endpoint placement

    Validation: Required; must be valid subnet IDs within the specified VPC

    vpcId: string

    VPC ID where the SFTP server will be deployed. The security group and server endpoints are created within this VPC.

    Use cases: VPC-based SFTP deployment; Network isolation for file transfers

    AWS: VPC for Transfer Family server endpoint and security group

    Validation: Required; must be existing VPC ID

    Settings

    Member Visibility

    On This Page

    Properties