# ec2-ssm-connect
An interactive command-line tool to list Amazon EC2 instances and establish secure connections using AWS Systems Manager (SSM) Session Manager.
## 🚀 Installation
Before using this tool, ensure you have the AWS CLI installed. This tool depends on it. [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
``` bash
pip install ec2-ssm-connect
```
## 🛠 Usage
The application reads the AWS CLI credentials from the environment variables.
After installation, you can use the command:
``` bash
ec2-ssm-connect
```
To filter EC2 instances by name:
``` bash
ec2-ssm-connect --filter [INSTANCE_NAME]
```
Example:
``` bash
$ ec2-ssm-connect
1. ID: i-0bb72e6f61ef2s612 Name: acme-aws-int-keycloak-ec2
2. ID: i-0819d17cdf4ees213 Name: acme-aws-int-auth-proxy-ec2
3. ID: i-082949bfd9b12s7cf Name: acme-aws-int-auth-app-ec2
4. ID: i-0caaf2ffbb132se5b Name: acme-aws-int-auth-web-ec2
5. ID: i-0dd580f86932as157 Name: jenkins-int-instance
6. ID: i-001bfa8b72680s6d9 Name: vault-int-ecs-instance
7. ID: i-0295e01f6bc12se68 Name: server01-int-ecs-instance
Enter the number of the EC2 instance you want to connect to: [HERE YOU ENTER THE NUMBER OF THE INSTANCE YOU WANT TO CONNECT TO, IN THIS CASE 1 TO 7]
$ ec2-ssm-connect -f jenkins
1. ID: i-0dd580f86932as157 Name: jenkins-int-instance
Enter the number of the EC2 instance you want to connect to: [HERE YOU ENTER THE NUMBER OF THE INSTANCE YOU WANT TO CONNECT TO, IN THIS CASE ONLY 1 IS POSSIBLE]
```
## 📦 Dependencies
- **boto3**: For AWS SDK functionalities.
- **AWS CLI**: Required for establishing connections with EC2 instances.
## ✍️ Author
- **Ingo Marlos Batista de Sousa**
## 📜 License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://www.github.com/ingomarlos/ec2-ssm-connect",
"name": "ec2-ssm-connect",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "aws,ec2,ssm,systems manager,session manager",
"author": "Ingo Marlos Batista de Sousa",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/1e/bf/2124824d1567271a4288107659451436e84ec2daa024ce819e8ccc59dfd8/ec2-ssm-connect-0.1.5.tar.gz",
"platform": null,
"description": "# ec2-ssm-connect\n\nAn interactive command-line tool to list Amazon EC2 instances and establish secure connections using AWS Systems Manager (SSM) Session Manager.\n\n\n## \ud83d\ude80 Installation\n\nBefore using this tool, ensure you have the AWS CLI installed. This tool depends on it. [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\n\n``` bash\npip install ec2-ssm-connect\n```\n\n## \ud83d\udee0 Usage\n\nThe application reads the AWS CLI credentials from the environment variables.\nAfter installation, you can use the command:\n\n``` bash\nec2-ssm-connect\n```\n\nTo filter EC2 instances by name:\n\n``` bash\nec2-ssm-connect --filter [INSTANCE_NAME]\n```\n\nExample:\n\n``` bash\n$ ec2-ssm-connect\n1. ID: i-0bb72e6f61ef2s612 Name: acme-aws-int-keycloak-ec2\n2. ID: i-0819d17cdf4ees213 Name: acme-aws-int-auth-proxy-ec2\n3. ID: i-082949bfd9b12s7cf Name: acme-aws-int-auth-app-ec2\n4. ID: i-0caaf2ffbb132se5b Name: acme-aws-int-auth-web-ec2\n5. ID: i-0dd580f86932as157 Name: jenkins-int-instance\n6. ID: i-001bfa8b72680s6d9 Name: vault-int-ecs-instance\n7. ID: i-0295e01f6bc12se68 Name: server01-int-ecs-instance\nEnter the number of the EC2 instance you want to connect to: [HERE YOU ENTER THE NUMBER OF THE INSTANCE YOU WANT TO CONNECT TO, IN THIS CASE 1 TO 7]\n\n$ ec2-ssm-connect -f jenkins\n1. ID: i-0dd580f86932as157 Name: jenkins-int-instance\nEnter the number of the EC2 instance you want to connect to: [HERE YOU ENTER THE NUMBER OF THE INSTANCE YOU WANT TO CONNECT TO, IN THIS CASE ONLY 1 IS POSSIBLE]\n```\n\n\n## \ud83d\udce6 Dependencies\n\n- **boto3**: For AWS SDK functionalities.\n- **AWS CLI**: Required for establishing connections with EC2 instances.\n\n## \u270d\ufe0f Author\n\n- **Ingo Marlos Batista de Sousa**\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "",
"summary": "An interactive command-line tool to list Amazon EC2 instances and establish secure connections using AWS Systems Manager (SSM) Session Manager.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://www.github.com/ingomarlos/ec2-ssm-connect"
},
"split_keywords": [
"aws",
"ec2",
"ssm",
"systems manager",
"session manager"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e0902073a24a7decc1c160128c050b7e3e9c7a7e2315317de4fd5d9299346aa",
"md5": "b10c91ecc652a637ed6031f210dac625",
"sha256": "d232ba498fe38a40e4819f6d849084d463d0797876d8261867cdf37c2d770b45"
},
"downloads": -1,
"filename": "ec2_ssm_connect-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b10c91ecc652a637ed6031f210dac625",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4712,
"upload_time": "2023-08-25T07:48:55",
"upload_time_iso_8601": "2023-08-25T07:48:55.820356Z",
"url": "https://files.pythonhosted.org/packages/5e/09/02073a24a7decc1c160128c050b7e3e9c7a7e2315317de4fd5d9299346aa/ec2_ssm_connect-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ebf2124824d1567271a4288107659451436e84ec2daa024ce819e8ccc59dfd8",
"md5": "b2f8ffff0e7174f1db043b1031c593bd",
"sha256": "b04fd887ef4970c212223a38ffff4bb9c7da4e9e54c8a740050307974ad6c79c"
},
"downloads": -1,
"filename": "ec2-ssm-connect-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b2f8ffff0e7174f1db043b1031c593bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4237,
"upload_time": "2023-08-25T07:48:57",
"upload_time_iso_8601": "2023-08-25T07:48:57.353216Z",
"url": "https://files.pythonhosted.org/packages/1e/bf/2124824d1567271a4288107659451436e84ec2daa024ce819e8ccc59dfd8/ec2-ssm-connect-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-25 07:48:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ingomarlos",
"github_project": "ec2-ssm-connect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ec2-ssm-connect"
}
JSON
