EC2-REQUEST-SPOT-INSTANCES(1)

📦 version 1.6.14.1, in ubuntu jammy, ubuntu noble

👑 EC2-REQUEST-SPOT-INSTANCES 👑

okay bestie, listen — this is the manual page for ec2-request-spot-instances(1), living in the User Commands section. it's a whole vibe, it's a whole tool, and we're gonna go through it together. grab a snack. 💖

🎀 NAME 🎀

ec2-request-spot-instances — create a spot instance request. that's it. that's the whole job. iconic. ✨

🌸 SYNOPSIS 🌸

 ec2rsi ([ec2-request-spot-instances])
 ec2rsi [GENERAL OPTIONS] AMI [SPECIFIC OPTIONS]

yes she has a nickname. ec2rsi. we love a short king. 🫶

🦋 GENERAL NOTES 🦋

literally any command option or parameter can be handed a value of -, and that means "bestie, read the values for this option from stdin instead." very demure, very flexible. 💅

💜 DESCRIPTION 💜

Creates a spot instance request. short, sweet, and it means business. 🔥

✨ GENERAL OPTIONS ✨

  • -O, --aws-access-key KEY — your AWS Access Key ID. if you don't pass it, it defaults to whatever AWS_ACCESS_KEY is set to in your 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 — the 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). overrides the default. 👀 heads up, deprecated, so don't build your whole personality around it.
  • -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. we're just being honest here. 💀
  • -U, --url URL — specify URL as the web service URL to use. defaults to 'https://ec2.amazonaws.com' (that's 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 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 does not play about precedence. 👑
  • -D, --auth-dry-run — check whether you can perform the requested action instead of actually performing it. a little test run, a little vibe check. ✅
  • -v, --verbose — verbose output. give me all the details, I want the whole story.
  • -?, --help — display this help. your bestie when you're lost.
  • -H, --headers — display column headers.
  • --debug — display additional debugging information. for when you need to know everything. 🔍
  • --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': says that a block device that would otherwise be exposed at the specified device should be suppressed. for example: '/dev/sdb=none'
    • 'ephemeral[0-3]': says 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]]': says 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, which creates an empty Amazon EBS volume of the specified size.
      • '<size>': the size (in 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>': says whether the Amazon EBS volume should be deleted on instance termination. if you don't specify it, this defaults 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 you specify it multiple times) within which the instance(s) should be run. this determines the ingress firewall rules that get applied to the launched instances. defaults to the user's default group if you don't supply it.
  • -k, --key KEY-PAIR — specifies the key pair to use when launching the instance(s).
  • -m, --monitor — enables monitoring of the specified instance(s).
  • -n, --instance-count COUNT — the maximum number of spot instances to launch.
  • -p, --price PRICE — specifies the maximum hourly price for any spot instance launched to fulfill the request.
  • -r, --type REQUEST — specifies the spot instance request type; either 'one-time' or 'persistent'. pick your fighter. 🥊
  • -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.
  • --availability-zone-group GROUP — specifies the spot instance availability zone group.
  • --placement-group GROUP_NAME — specifies the placement group into which the instances should be launched.
  • --kernel KERNEL — specifies the ID of the kernel to launch the instance(s) with.
  • -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. don't be greedy bestie. 🙈

  • --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.
  • --launch-group GROUP — specifies the spot instance launch group.
  • --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. 💸 your wallet has been warned.
  • --ramdisk RAMDISK — specifies the ID of the ramdisk to launch the instance(s) with.
  • --valid-from VALIDFROM — the date and time after which the spot instance request will be considered for fulfillment; specified in the format 'yyyy-MM-ddTHH:mm:ss'.
  • --valid-until VALIDUNTIL — the date and time after which the spot instance request will expire and no longer be considered for fulfillment; specified in the format 'yyyy-MM-ddTHH:mm:ss'.
  • --secondary-private-ip-address SECONDARY-PRIVATE-IP-ADDRESS — specifies a secondary private IP address for the network interface of the instance to be launched.
  • --secondary-private-ip-address-count SECONDARY-PRIVATE-ADDRESS-COUNT — specifies a number of secondary private IP addresses to be dynamically assigned to 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, no notes. this little love letter comes to you from the EC2 API command line tools, version 1.6.14.1, api=2014-05-0 — so if you're out here launching spot instances, go off, you absolute legend. 💅✨🦋 periodt.

📦 where this page comes from