aws / aws-ec2-instance-connect-cli

This is an all-in-one client for EC2 Instance Connect that handles key brokerage and establishing connection to EC2 Instances through an interface near-identical to standard system ssh, sftp, and other utilities.

AWS EC2 Instance Connect CLI

**[IMPORTANT] Since June 2023, the AWS CLI includes the ssh command. The AWS CLI ssh command allows you to connect to your instances directly over the internet or to instances in a private subnet using EC2 Instance Connect. We strongly recommend using the AWS CLI ssh command rather than this package.

This is a Python client for accessing EC2 instances via AWS EC2 Instance Connect. This module supports Python 3.6.x+. This package is available on PyPI for pip installation, ie, pip install ec2instanceconnectcli

Setup

It is strongly encouraged you set up a virtual environment for building and testing.

Prerequisites

To set up this package you need to have pip installed.

Package Setup

Install the package dependencies

pip install -r requirements.txt

Running

Ensure your PYTHONPATH includes the package top-level directory.

Run the desired script with standard UNIX pathing. For example,

./bin/mssh [e-mail] -pr dev -t i-0b01816d5c99826d8 -z us-west-2a

Testing

Unit tests can be run with standard pytest. They may be run, for example, by

python -m pytest

Also, for correcting import when using virtualenv, you have to export PYTHONPATH by running: export PYTHONPATH=$(pwd)

Generating Documentation

Sphinx configuration has been included in this package. To generate Sphinx documentation, run

pip install -r requirements-docs.txt

to pull dependencies. Then, run

sphinx-apidoc -o doc/source ec2instanceconnectcli

to generate the module documentation reStructuredText files. Finally, run

sphinx-build ./doc/source [desired output directory]

to generate the actual documentation html.