UNPKG

2.37 kBMarkdownView Raw
1# ec2-check
2
3[![NPM version][npm-image]][npm-url]
4[![NPM downloads][downloads-image]][downloads-url]
5[![Install Size](https://packagephobia.now.sh/badge?p=ec2-check)](https://packagephobia.now.sh/result?p=ec2-check)
6
7> A CLI tool to check whether your AWS EC2 instances are encrypted.
8
9## Installation
10
11```sh
12npm install -g ec2-check
13```
14
15## Usage
16
17All Regions
18
19```shell
20$ ec2-check
21
22 ########################################
23 AWS EC2 Encryption Check
24 ########################################
25
26 Scanning Instances
27
28 Volume ID: vol-05d216aa3675bf496
29 Availability Zone: us-east-2c
30 Name: Blog/Portfolio
31 State: in-use
32 Encrypted: False!
33
34 Volume ID: vol-088d60f4b643af66f
35 Availability Zone: us-east-1b
36 Name: kyleobrien.io
37 State: in-use
38 Encrypted: False!
39
40 ########################################
41```
42
43Specific Region
44
45```shell
46$ ec2-check --region us-east-2
47
48 ########################################
49 AWS EC2 Encryption Check
50 ########################################
51
52 Scanning Instances
53
54 Volume ID: vol-06a98698ebb44ffd4
55 Availability Zone: us-east-2b
56 Name: Polafide
57 State: in-use
58 Encrypted: False!
59
60 Volume ID: vol-00ac0e505900ac0b2
61 Availability Zone: us-east-2b
62 Name: Remote.it Docker Test
63 State: in-use
64 Encrypted: False!
65
66 ########################################
67```
68
69## Help
70
71```bash
72$ ec2-check -h
73
74 Usage: ec2-check [options]
75
76 A tool to check whether your AWS EC2 instances are encrypted.
77
78 Options:
79
80 -V, --version output the version number
81 -r, --region Specify a particular region to lookup.
82 -h, --help output usage information
83```
84
85## License
86
87MIT
88
89[npm-image]: https://img.shields.io/npm/v/ec2-check.svg?style=flat
90[npm-url]: https://www.npmjs.com/package/ec2-check
91[downloads-image]: https://img.shields.io/npm/dm/ec2-check.svg?style=flat
92[downloads-url]: https://www.npmjs.com/package/ec2-check
93[travis-image]: https://img.shields.io/travis/{{{username}}}/{{{repoName}}}.svg?style=flat
94[travis-url]: https://travis-ci.org/{{{username}}}/{{{repoName}}}
95[coveralls-image]: https://img.shields.io/coveralls/{{{username}}}/{{{repoName}}}.svg?style=flat
96[coveralls-url]: https://coveralls.io/r/{{{username}}}/{{{repoName}}}?branch=master
\No newline at end of file