Skip to main content

Quickly launch an EC2 instance for small tasks

Project description

ec2instance

ec2instance is the "docker run -it" of AWS EC2. It is a single command that very quickly launches an EC2 instance from the CLI and takes care of the legwork to make it immediately usable for you.

Demo

asciicast

Install

pip install ec2instance

Usage

usage: ec2instance [-h] [-t INSTANCE_TYPE] [-i AMI_IDENTIFIER] [-f USER_DATA_FILENAME]
                   [--volume-size VOLUME_SIZE] [--profile PROFILE_NAME] [--region AWS_REGION]
                   [--non-interactive] [--show-data-path]

Quickly launch an EC2 instance for small tasks. The instance's lifecycle is tied to the process,
enabling easy Ctrl+C instance termination when done.

optional arguments:
  -h, --help            show this help message and exit
  -t INSTANCE_TYPE, --type INSTANCE_TYPE
                        EC2 instance type. (default: t3a.micro)
  -i AMI_IDENTIFIER, --ami AMI_IDENTIFIER
                        EC2 AMI id. You may also pass "ubuntu" as a shortcut to get the latest
                        Ubuntu LTS, or "amazonlinux" as a shortcut to get the latest Amazon Linux.
                        (default: ubuntu)
  -f USER_DATA_FILENAME, --user-data USER_DATA_FILENAME
                        EC2 user data. Path to a shell script. AWS will upload and run this script
                        on the instance immediately after launch. (default:
                        /home/john/.config/ec2instance_cmd/user_data_scripts/default.sh)
  --volume-size VOLUME_SIZE
                        Root EBS volume size (GiB).
  --profile PROFILE_NAME
                        AWS credentials profile name to use.
  --region AWS_REGION   Specific AWS region to use.
  --non-interactive     By default a shell will be opened in the spawned instance, and the
                        instance will be terminated when the shell is closed. To instead output
                        ec2 metadata as json and then exit, specify --non-interactive.
  --show-data-path      Print out the path where ec2instance is storing local data and
                        configuration.

help & support: https://github.com/personalcomputer/ec2instance/issues

Notes

  • Before using ec2instance, you must configure AdministratorAccess-level AWS authentication credentials locally:
    • 1.) install awscli
    • 2.) Run aws configure and enter in your AWS access key. How to get an AWS access key is not in scope of this guide.
  • Upon running ec2instance for the first time on a new machine, it will tell you it is automatically creating a tiny sandbox in your AWS account to ensure that there are no possible conflicts or security concerns from using ec2instance. This sandbox consists of generating a dedicated fresh VPC and SSH keypair, and these are persisted them between invocations of ec2instance. There is no AWS fee associated with these resources, and their auto-generated names are very obvious and logged to console. Feel free to delete them if you stop using ec2instance.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ec2instance-1.2.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

ec2instance-1.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file ec2instance-1.2.tar.gz.

File metadata

  • Download URL: ec2instance-1.2.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for ec2instance-1.2.tar.gz
Algorithm Hash digest
SHA256 d9876221fce075aa8ed76476cec3e26b66a0363c36c11adba4e4645a20d42593
MD5 9f5f86a3e7d11abf459e3a0ade343f62
BLAKE2b-256 be0c6298b2f6a8ed782f0cb966986da1dd82ee228fb169c8a4e5737e8df45ce3

See more details on using hashes here.

File details

Details for the file ec2instance-1.2-py3-none-any.whl.

File metadata

  • Download URL: ec2instance-1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for ec2instance-1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 13e89c73c8cca73532d6d7cd3d226e413eacc070924f143f0432bd61354397ce
MD5 15689c6127d8dadb672e3d8c76ad190e
BLAKE2b-256 bc007e55c7e175d055c17018e23fea37346dba112bcb16fe6652c27a7784b9a3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page