EC2-RUN-INSTANCES(1)

📦 version 1.6.14.1, in ubuntu jammy, ubuntu noble

💖 EC2-RUN-INSTANCES(1) — the "ec2-run-instances" glow-up 💖

okay bestie, welcome to the User Commands section, this is ec2-run-instances and it is literally the moment your cloud dreams get a body. let's go 🦋

✨ NAME ✨

ec2-run-instances — launch instances of an image. yes. that's the whole job. iconic behavior honestly 💅

🌸 SYNOPSIS 🌸

ec2run ([ec2-run-instances])
ec2run [GENERAL OPTIONS] AMI [SPECIFIC OPTIONS]

🎀 GENERAL NOTES 🎀

real talk: any command option or parameter can be handed a value of - and that means read the values for that option from stdin. every single one. no cap. 🫶

💜 DESCRIPTION 💜

You launch a bunch of instances of a specified AMI. that's it, that's the vibe ✨

The AMI parameter is the AMI ID of the AMI to launch. yes bestie the AMI parameter takes the AMI ID, we love a self-explanatory queen 👑

🌈 GENERAL OPTIONS 🌈

  • -O, --aws-access-key KEY — your AWS Access Key ID. defaults to whatever AWS_ACCESS_KEY is set to in the environment (if it's set at all) 🔑
  • -W, --aws-secret-key KEY — your AWS Secret Access Key. defaults to the AWS_SECRET_KEY environment variable (if set) 🤫
  • -T, --security-token TOKEN — AWS delegation token. defaults to the AWS_DELEGATION_TOKEN environment variable (if set) 🎫
  • -K, --private-key KEY — [DEPRECATED] specify KEY as the private key to use. defaults to the value of the EC2_PRIVATE_KEY environment variable (if set), and overrides the default 🔐
  • -C, --cert CERT — [DEPRECATED] specify CERT as the X509 certificate to use. defaults to the value of the EC2_CERT environment variable (if set), and overrides the default 📜
  • -U, --url URL — specify URL as the web service URL to use. defaults to https://ec2.amazonaws.com (us-east-1) or to the value of the EC2_URL environment variable (if set). overrides the default 🌐
  • --region REGION — specify REGION as the web service region to use. this option overrides the URL given by the -U URL option and the EC2_URL environment variable. it defaults to the region specified by the EC2_URL environment variable, or us-east-1 if that env var isn't set 📍
  • -D, --auth-dry-run — check whether you could do the thing instead of actually doing the thing. a vibe check for your permissions, basically 👀
  • -v, --verbose — verbose output. give me all the lore 📢
  • -?, --help — display this help 🙋
  • -H, --headers — display column headers 🏷️
  • --debug — display additional debugging information 🐛
  • --show-empty-fields — indicate empty fields 🕳️
  • --hide-tags — do not display tags for tagged resources 🙈
  • --connection-timeout TIMEOUT — specify a connection timeout TIMEOUT (in seconds) ⏳
  • --request-timeout TIMEOUT — specify a request timeout TIMEOUT (in seconds) ⏰

🔥 SPECIFIC OPTIONS 🔥

  • -b, --block-device-mapping MAPPING — defines a block device mapping for the image, in the form '<device>=<block-device>', where 'block-device' can be one of the following 💾
    • 'none': indicates that a block device that would be exposed at the specified device should be suppressed. for example: /dev/sdb=none
    • 'ephemeral[0-3]': indicates that the Amazon EC2 ephemeral store (instance local storage) should be exposed at the specified device. for example: /dev/sdc=ephemeral0.
    • '[<snapshot-id>][:<size>[:<delete-on-termination>][:<type>[:<iops>]][:encrypted]]': indicates that an Amazon EBS volume, created from the specified Amazon EBS snapshot, should be exposed at the specified device. the following combinations are supported:
      • '<snapshot-id>': the ID of an Amazon EBS snapshot, which must be owned by the caller. may be left out if a <size> is specified, creating an empty Amazon EBS volume of the specified size.
      • '<size>': the size (GiBs) of the Amazon EBS volume to be created. if a snapshot was specified, this may not be smaller than the size of the snapshot itself.
      • '<delete-on-termination>': indicates whether the Amazon EBS volume should be deleted on instance termination. if not specified, this will default to 'true' and the volume will be deleted.
      • '<type>': specifies the volume type. this can be either 'standard' or 'io1'. defaults to standard.
      • '<iops>': the requested number of I/O operations per second that the volume can support.
      • 'encrypted': indicates that the volume should be encrypted.

for example:

'/dev/sdb=snap-7eb96d16'
'/dev/sdc=snap-7eb96d16:80:false'
'/dev/sdc=snap-7eb96d16:80:false:io1:100'
'/dev/sdd=:120'
'/dev/sdd=:120:encrypted'

see the latest Developer's Guide for further information 📚

  • -d, --user-data DATA — specifies the user data to be made available to the instance(s) in this reservation 📝
  • -f, --user-data-file DATA-FILE — specifies the file containing user data to be made available to the instance(s) in this reservation 📄
  • -g, --group GROUP [--group GROUP...] — specifies the security group (or groups, if specified multiple times) within which the instance(s) should be run. determines the ingress firewall rules that will be applied to the launched instances. defaults to the user's default group if not supplied 🛡️
  • -k, --key KEYPAIR — specifies the name of the key pair to use when launching the instance(s) 🗝️
  • -m, --monitor — enables monitoring of the specified instance(s) 📊
  • -n, --instance-count MIN[-MAX] — the number of instances to attempt to launch. may be specified as a single integer or as a range (min-max). this specifies the minimum and maximum number of instances to attempt to launch. if a single integer is specified, min and max are both set to that value 🔢
  • -s, --subnet SUBNET — the ID of the Amazon VPC subnet in which to launch the instance(s) 🕸️
  • -t, --instance-type TYPE — specifies the type of instance to be launched. refer to the latest Developer's Guide for valid values 🖥️
  • -z, --availability-zone ZONE — specifies the availability zone to launch the instance(s) in. run the 'ec2-describe-availability-zones' command for a list of values, and see the latest Developer's Guide for their meanings 🗺️
  • --addressing ADDRESSING — specifies the addressing type to use for the instance(s). refer to the latest Developer's Guide for valid values 🏠
  • --disable-api-termination — indicates that the instance(s) may not be terminated using the TerminateInstances API call 🚫
  • --instance-initiated-shutdown-behavior BEHAVIOR — indicates what the instance(s) should do if an on instance shutdown is issued. the following values are supported:
    • 'stop': indicates that the instance should move into the stopped state and remain available to be restarted.
    • 'terminate': indicates that the instance should move into the terminated state.
  • --kernel KERNEL — specifies the ID of the kernel to launch the instance(s) with 🌰
  • --license-pool LICENSE_POOL — specifies the license pool to use when launching the instance(s) 🪪
  • --ramdisk RAMDISK — specifies the ID of the ramdisk to launch the instance(s) with 💿
  • --placement-group GROUP_NAME — specifies the placement group into which the instances should be launched 🧩
  • --private-ip-address IP_ADDRESS — specifies the private IP address to use when launching an Amazon VPC instance 🏡
  • -p, --iam-profile ARN — specifies the IAM profile to associate with the launched instance(s). IAM profiles enable you to manage permissions for applications running on EC2. this is either the ARN of the profile or the name of the role 🎭
  • --client-token TOKEN — client token for idempotency. so if you accidentally send it twice, it's not twice bestie, it's once 🔁
  • --tenancy TENANCY — specifies the tenancy of an instance, which can be default or dedicated.
    • default: the default tenancy.
    • dedicated: the instance does not share hardware with instances launched from other accounts (additional charges apply).

this option is only available for VPC instances 🔒

  • --ebs-optimized — provides dedicated throughput to Amazon EBS and a software stack optimized for EBS I/O. additional usage charges apply when using this option 💸
  • -a, --network-attachment NETWORKATTACHMENT — specifies the network attachment for the instance to launch. the format of the attachment definition is as follows:
<nic>:<dev index>[:<subnet>[:<description>[:<priv IP>[:<SGs>[:<DOT>[:SIP count[:<SIPs>]]]]]]]

where:

  • SGs is a comma separated list of security group IDs.
  • DOT is either true or false, denoting whether to delete the interface on termination.
  • SIP count is the count of secondary private IP addresses.
  • SIPs is a list of secondary private IP addresses.
specify only one of SIP count or SIPs. pick a lane bestie, not both 💅
  • --secondary-private-ip-address SECONDARY-PRIVATE-IP-ADDRESS — the secondary private IP address to assign to the specified network interface of the instance to be launched 📮
  • --secondary-private-ip-address-count SECONDARY-PRIVATE-ADDRESS-COUNT — the number of secondary private IP addresses to be automatically assigned to the specified network interface of the instance to be launched 🔢
  • --associate-public-ip-address BOOLEAN — specify whether or not an AWS public IP address should be assigned to the eth0 of the instances to be launched. instances launched into a default subnet are assigned a public IP address by default 🌍

🦋 SEE ALSO 🦋

and that's the whole page bestie, you ate 💖 this was the EC2 API command line tools, version 1.6.14.1, api=2014-05-01, manual page EC2-RUN-INSTANCES(1). go launch something iconic. periodt. 👑✨

📦 where this page comes from