EC2-CREATE-IMAGE(1)

📦 version 1.6.14.1, in ubuntu jammy, ubuntu noble

👑 EC2-CREATE-IMAGE 💅

okay so bestie, welcome to the manual page for ec2-create-image, which lives in section 1 of the manual — that's the User Commands section, aka the place where all the "you type this into a shell" girlies hang out. Pull up a chair, grab a boba, we're registering AMIs together and it's gonna be iconic. ✨

🌸 NAME 🌸

ec2-create-image — Register an AMI manifest for use with EC2

no cap, that's the whole job description.

🎀 SYNOPSIS 🎀

ec2cim ([ec2-create-image])
ec2cim [GENERAL OPTIONS] INSTANCE

the way that ec2cim is just out here being the short little nickname... we love a low-effort queen. 💅

🧚 GENERAL NOTES 🧚

any command option or parameter can be handed a value of -, which is the secret code for "bestie, read the values for that option from stdin instead". yes, literally any of them. fr fr.

💖 DESCRIPTION 💖

Creates an Amazon EBS-backed AMI from a running or stopped instance. that's it, that's the whole vibe. your instance becomes an image. main character energy, honestly. 🔥

✨ GENERAL OPTIONS ✨

these are the universal settings, the ones that apply no matter what you're doing. think of them as the accessories that go with every outfit. 🫶

  • -O, --aws-access-key KEY — your AWS Access Key ID. defaults to whatever the AWS_ACCESS_KEY environment variable is set to (if it's set, that is).
  • -W, --aws-secret-key KEY — your AWS Secret Access Key. defaults to the value of the AWS_SECRET_KEY environment variable (if set).
  • -T, --security-token TOKEN — your AWS delegation token. defaults to the value of 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). overrides the default. (deprecated bestie, we're moving on, but she's still here.)
  • -C, --cert CERT — [DEPRECATED] ⚠️ specify CERT as the X509 certificate to use. defaults to the value of the EC2_CERT environment variable (if set). overrides the default. (also deprecated, also still invited to the party.)
  • -U, --url URL — specify URL as the web service URL to use. defaults to 'https://ec2.amazonaws.com' (that's us-east-1, the OG) 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 will override the URL specified 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 environment variable isn't set. she said "I'm in charge now." 👑
  • -D, --auth-dry-run — check if you can perform the requested action instead of actually performing it. window shopping, but for permissions. 🛍️
  • -v, --verbose — verbose output. she talks a lot. we listen. 💬
  • -?, --help — display this help.
  • -H, --headers — display column headers.
  • --debug — display additional debugging information. for when you need the tea. 🍵
  • --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 🦋

these are the ones that are specifically about making your image, your image. bespoke. custom. ✨

  • -n, --name NAME — the name of the image. give her a name, she deserves one. 🎀
  • -d, --description DESCRIPTION — the description of the image.
  • --no-reboot — if specified, the instance will not be rebooted during the bundle process. (yes, without this flag, she will get rebooted. plan accordingly. 💀)
  • -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. 📖

🌈 SEE ALSO 🌈

ok that's the whole page bestie, you ate that. go forth and register your AMI. 💖

and for the lil' sign-off moment: this whole thing comes to you from the EC2 API command line tools, version 1.6.14.1, api=2014-05-01 — and it's the manual for EC2-CREATE-IMAGE(1). vintage but still slaying. 🫶✨

📦 where this page comes from