# leapp-ec2-instance-connect-plugin

> The Leapp plugin to establish SSH remoting and forwarding via EC2 instance connect

Latest version **1.0.112** (published 2025-12-11) · MPL license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install leapp-ec2-instance-connect-plugin
pnpm add leapp-ec2-instance-connect-plugin
yarn add leapp-ec2-instance-connect-plugin
bun add leapp-ec2-instance-connect-plugin
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.112 |
| Published | 2025-12-11 |
| First published | 2023-01-07 |
| Weekly downloads | 0 |
| License | MPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 326.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | tonidy |
| Maintainers | tonidy |
| Keywords | leapp-plugin, aws |

## Links

- npm: https://www.npmjs.com/package/leapp-ec2-instance-connect-plugin
- Repository: https://github.com/tonidy/leapp-ec2-connect-plugin
- Homepage: https://github.com/tonidy/leapp-ec2-connect-plugin#readme
- Issues: https://github.com/tonidy/leapp-ec2-connect-plugin/issues
- npm.io page: https://npm.io/package/leapp-ec2-instance-connect-plugin

## Dependencies (1)

- [@noovolari/leapp-core](https://npm.io/package/@noovolari/leapp-core.md) 0.1.165

## Recent versions

- 1.0.112 (latest) — 2025-12-11
- 1.0.109 — 2025-10-01
- 1.0.102 — 2025-08-14
- 1.0.101 — 2025-08-14
- 1.0.93 — 2025-05-07
- 1.0.88 — 2025-04-07
- 1.0.78 — 2025-01-22
- 1.0.66 — 2024-10-23
- 1.0.62 — 2024-08-24
- 1.0.59 — 2024-07-02
- 1.0.56 — 2024-06-12
- 1.0.51 — 2024-03-18
- 1.0.49 — 2024-03-07
- 1.0.46 — 2024-02-20
- 1.0.41 — 2024-01-24
- … 19 more at https://npm.io/package/leapp-ec2-instance-connect-plugin/versions

## README

# [Leapp](https://www.leapp.cloud) EC2 Instance Connect Plugin</h1>

## Introduction

This plugin aims to help developers and AWS users in general for remoting and forwarding into EC2 instance!
This plugin source code inspiration ~~(copy and edit)~~ based on:

`https://github.com/christian-calabrese/leapp-ssm-tunnels-plugin`

## How it works?

The plugin uses this command `aws ec2-instance-connect send-ssh-public-key` to upload SSH public key to EC2 instance. Then SSH-ing (remote/forward) to EC2 instance (test).

## Plugin in action!

It's possible to install and use this plugin as well explained by the Noovolari team throughout the Leapp's documentation that you can find here:
[Leapp plugins introduction](https://docs.leapp.cloud/0.17.0/plugins/plugins-introduction)

## How to install?

1. Open Settings (⚙)
2. Click Plugins
3. Type `leapp-ec2-instance-connect-plugin` in `Insert an npm package name`
4. Click plus icon (⊕)

![How to install](how_to_install.png)


## How to configure the plugin?

This plugin makes use of a json configuration file (`ec2-connect-config.json`) where you can specify the parameters needed to establish the tunnel.

You can use the below example to create your own file and place it in the Leapp installation folder (usually in `$HOME` (macos/linux/powershell) or `%USERPROFILE%` (windows/CMD) user directory).

For example:

`$HOME/.Leapp/ec2-connect-config.json`

You can find an example of such file in this repository called `ec2-connect-config.example.json`

```json
[
  {
    "sessionName": "Session1",
    "availabilityZone": "ap-southeast-1c",
    "instanceId": "i-0abcdefghijkl1234",
    "instanceOSUser": "ec2-user",
    "instanceIPAddress": "8.8.8.8",
    "sshPath": "/home/username/.ssh",
    "sshPublicKeyFile": "id_ed25519.pub",
    "sshPrivateKeyFile": "id_ed25519",
    "modeType": "remoting/forwarding",
    "mode": "forwarding",
    "configs": [
      {
        "remoteHost": "ec2instancename.xxxx.ap-southeast-1.rds.amazonaws.com",
        "remotePort": "3306",
        "localPort": "3307"
      }
    ]
  },
  {
    "sessionName": "Session2",
    "availabilityZone": "ap-southeast-1c",
    "instanceId": "i-0abcdefghijkl1234",
    "instanceOSUser": "ec2-user",
    "instanceIPAddress": "8.8.8.8",
    "sshPath": "/home/username/.ssh",
    "sshPublicKeyFile": "id_ed25519.pub",
    "sshPrivateKeyFile": "id_ed25519",
    "modeType": "remoting/forwarding",
    "mode": "remoting"
  }
]
```

## How to use?

1. Configure the plugin (see `How to configure the plugin?` section)
2. Create [AWS session](https://docs.leapp.cloud/0.17.0/configuration)
3. Right click on the session
4. Choose Plugins
5. Click `Start EC2 instance connect`

![How to use](how_to_use.jpg)

<!-- triggers -->

---
_Source: https://npm.io/package/leapp-ec2-instance-connect-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._