spawn-ts API reference - v0.6.0
    Preparing search index...

    Interface LaunchInput

    interface LaunchInput {
        allowUnbounded?: boolean;
        ami?: string;
        completionDelay?: string | number;
        completionFile?: string;
        costLimit?: number;
        dnsName?: string;
        hibernateOnIdle?: boolean;
        hooks?: LifecycleHooks;
        idleCpuPercent?: number;
        idleTimeout?: string | number;
        instanceType?: string;
        jobArray?: JobArrayMembership;
        keyPair?: string;
        name: string;
        onComplete?: "" | LifecycleAction;
        pricePerHour?: number;
        region?: string;
        sessionTimeout?: string | number;
        spot?: boolean;
        sweep?: SweepMembership;
        ttl?: string | number;
    }
    Index
    allowUnbounded? ami? completionDelay? completionFile? costLimit? dnsName? hibernateOnIdle? hooks? idleCpuPercent? idleTimeout? instanceType? jobArray? keyPair? name onComplete? pricePerHour? region? sessionTimeout? spot? sweep? ttl?
    allowUnbounded?: boolean

    Bypass the "real launch needs a bound" safety check.

    ami?: string
    completionDelay?: string | number
    completionFile?: string
    costLimit?: number
    dnsName?: string

    DNS label override; defaults to a slugified name (see LaunchSpec.dnsName).

    hibernateOnIdle?: boolean
    hooks?: LifecycleHooks

    Daemon-enforced lifecycle hooks; stamps the pre-stop/webhook/notify tags.

    idleCpuPercent?: number
    idleTimeout?: string | number
    instanceType?: string
    jobArray?: JobArrayMembership

    Job-array membership; stamps spawn:job-array-* tags.

    keyPair?: string
    name: string
    onComplete?: "" | LifecycleAction
    pricePerHour?: number
    region?: string
    sessionTimeout?: string | number

    Idle-SSH-shell auto-logout (Go-form duration or ms). 0/absent = disabled.

    spot?: boolean
    sweep?: SweepMembership

    Parameter-sweep membership; stamps spawn:sweep-* / spawn:param:* tags.

    ttl?: string | number

    Any Go-form duration string ("4h") or ms number. 0/absent = none.

    Settings
    Member Visibility

    On This Page
    Properties