EC2-REGISTER(1)

📦 version 1.6.14.1, in ubuntu jammy, ubuntu noble

💖 EC2-REGISTER 💖

okay bestie, pull up a chair, we're doing ec2-register from the EC2 API command line tools — that's the ec2-register(1) manual page, and yes it's a whole thing but I got you 🫶

✨ NAME ✨

ec2-register — register an image, no cap 🌸

🎀 SYNOPSIS 🎀

ec2reg ([ec2-register])
ec2reg [GENERAL OPTIONS] [MANIFEST] [SPECIFIC OPTIONS]

📝 GENERAL NOTES 📝

okay so here's a lil cheat code that applies to literally every single option and parameter on this page: you can pass it a value of - and that means read the value from stdin instead. that's it, that's the note. iconic. 💅

🦋 DESCRIPTION 🦋

You register an Amazon Machine Image — an AMI, which is the whole vibe — so it can be used inside Amazon EC2. that's the entire job. main character energy fr fr ✨

👑 GENERAL OPTIONS 👑

  • -O, --aws-access-key KEY — your AWS Access Key ID. defaults to whatever the AWS_ACCESS_KEY environment variable says (if it's set, bestie).
  • -W, --aws-secret-key KEY — your AWS Secret Access Key. defaults to the AWS_SECRET_KEY environment variable (if set).
  • -T, --security-token TOKEN — the AWS delegation token. defaults to the AWS_DELEGATION_TOKEN environment variable (if set).
  • -K, --private-key KEY — [DEPRECATED] use KEY as the private key. defaults to the EC2_PRIVATE_KEY environment variable (if set). overrides the default. (yes it's deprecated, use at your own risk bestie 😭)
  • -C, --cert CERT — [DEPRECATED] use CERT as the X509 certificate. defaults to the EC2_CERT environment variable (if set). overrides the default. (also deprecated 🙈)
  • -U, --url URL — use URL as the web service URL. defaults to https://ec2.amazonaws.com (that's us-east-1) or to whatever EC2_URL is set to (if set). overrides the default.
  • --region REGION — use REGION as the web service region. this one overrides the URL from the -U URL option and the EC2_URL environment variable. it defaults to the region from the EC2_URL environment variable, or us-east-1 if that variable isn't set.
  • -D, --auth-dry-run — vibe check only: see whether you could do the thing instead of actually doing the thing.
  • -v, --verbose — verbose output, so you get the tea ☕
  • -?, --help — display this help.
  • -H, --headers — display column headers.
  • --debug — display additional debugging information.
  • --show-empty-fields — indicate empty fields.
  • --hide-tags — don't display tags for tagged resources.
  • --connection-timeout TIMEOUT — set a connection timeout TIMEOUT (in seconds).
  • --request-timeout TIMEOUT — set a request timeout TIMEOUT (in seconds).

🔥 SPECIFIC OPTIONS 🔥

  • -a, --architecture ARCHITECTURE — the architecture of the image; either i386 or x86_64. if you don't specify, i386 gets used.
  • -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 these:
    • none — says that a block device that would be exposed at the specified device should be suppressed. for example: /dev/sdb=none
    • ephemeral[0-3] — says the Amazon EC2 ephemeral store (that's the instance local storage) should be exposed at the specified device. for example: /dev/sdc=ephemeral0.
    • [<snapshot-id>][:<size>[:<delete-on-termination>][:<type>[:<iops>]][:encrypted]] — says an Amazon EBS volume, created from the specified Amazon EBS snapshot, should be exposed at the specified device. these are the combos that are supported:
      • <snapshot-id> — the ID of an Amazon EBS snapshot, which has to be owned by the caller. you can leave it out if you specify a <size>, which creates 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 can't be smaller than the size of the snapshot itself.
      • <delete-on-termination> — whether the Amazon EBS volume should be deleted on instance termination. if not specified, this defaults to true and the volume will be deleted.
      • <type> — the volume type. either standard or io1. defaults to standard.
      • <iops> — the requested number of I/O operations per second that the volume can support.
      • encrypted — says 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, --description DESCRIPTION — the description of the image.
  • -n, --name NAME — the name of the image, which has to be between 3 and 128 characters long, and may contain letters, numbers and these special characters: ( ) . - / _
  • -s, --snapshot SNAPSHOT — the ID of the Amazon EBS snapshot to be used as the root device.
  • --kernel KERNEL — the ID of the kernel associated with the image.
  • --ramdisk RAMDISK — the ID of the ramdisk associated with the image.
  • --root-device-name ROOTDEVICENAME — the name of the root device, e.g. /dev/sda1.
  • --virtualization-type VIRTUALIZATION_TYPE — set the AMI virtualization type.
  • --sriov SRIOV — set SR-IOV networking support for the AMI.

🌈 SEE ALSO 🌈

and that's the whole page bestie, you ate that 🍓💅

this was EC2 API command line tools, version 1.6.14.1, api 2014-05-01 — shoutout to the EC2-REGISTER girlies, mwah 💖✨🎀
📦 where this page comes from