ec2-info

ec2-info

Extract ec2 metadata information from the local http interface on an ec2 instance

This module can be consumed programmatically or as a command line tool

Click here for complete reference about ec2 metadata information or better yet, use this module's cli to get an index of properties.

Beware, though, when traversing the ec2 metadata information tree! There are some "traps" one is ought to know of in advance, if one is to save precious time... this is discussed here

example

npm i ec2-info

const ec2Info = require('ec2-info')

let properties = ['meta-data/instance-id', 'meta-data/instance-type']

// fetch these properties
ec2Info(properties, (err, info) => {
    if (err) return console.error(err)
    // prints: Map { 'meta-data/instance-id' => 'foofoofoo', 'meta-data/instance-type' => 'm4-large' }
    console.log(info) 
})

// custom data url
let options = { dataURL: 'http://localhost:8080/latest/' }
ec2Info(properties, options, (err, info) => {
    if (err) return console.error(err)
    // prints: Map { 'meta-data/instance-id' => 'foofoofoo', 'meta-data/instance-type' => 'm4-large' }
    console.log(info) 
})

api

ec2Info(properties, callback [, options])

Fetch the specified set of properties and return them in the callback inside an ES6 Map object.

If used on anything other than an ec2 instance as determined by is-ec2-machine the module will still work without an error but all the property values will be not an ec2 machine.

You can disable that check by specifying the option { testIsEc2Machine: false }

You can also change the default url http://169.254.169.254/latest/ to something else by specifying the option { dataURL: 'http://localhost:8080/latest' }. This is helpful in testing or if you're using the package on your machine but want to port foward to an ec2 instance, e.g: ssh -f ec2-user@<ec2 host address> -L 8080:169.254.169.254:80 -N'

command line tool

npm i -g ec2-info

ec2-info --help

fetch some values:

ec2-info fetch --help

ec2-info fetch meta-data/public-ipv4 meta-data/instance-id --format=json

list some known keys

ec2-info index

debug

uses debug with namespace ec2-info

license

MIT © ironSource ltd