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

    Interface EC2ProviderOptions

    interface EC2ProviderOptions {
        accessKeyId: string;
        endpoint?: string;
        iamInstanceProfile?: string;
        publicKey?: string;
        region: string;
        secretAccessKey: string;
        sessionToken?: string;
        sporedSigningPublicKey?: string;
        username?: string;
    }
    Index
    accessKeyId endpoint? iamInstanceProfile? publicKey? region secretAccessKey sessionToken? sporedSigningPublicKey? username?
    accessKeyId: string
    endpoint?: string

    Override endpoint for substrate/localstack. Empty => real AWS.

    iamInstanceProfile?: string

    IAM instance profile (name or ARN) attached to launched instances. spored needs it to read spawn:* tags (ec2:DescribeTags/DescribeInstances) and to self-terminate (ec2:TerminateInstances/StopInstances on spawn:managed=true). Without it, an instance launches but can never wind itself down.

    publicKey?: string

    Default SSH public key to bake into launches (optional).

    region: string
    secretAccessKey: string
    sessionToken?: string
    sporedSigningPublicKey?: string

    PEM spore.host signing public key. When set, launched instances verify the spored binary's signature before running it (fail-closed). Absent = the bootstrap relies on the SHA256 checksum only. See userdata.ts.

    username?: string

    Login username for bootstrap (default ec2-user).

    Settings
    Member Visibility

    On This Page
    Properties