ec2deprecateimg(1)

📦 version 10.0.3, in opensuse-leap 16.0

💅 ec2deprecateimg — the ec2deprecateimg(1) glow-up

okay so you're in the General Commands Manual and the tool is ec2deprecateimg, and honestly? she's giving "I retire AMIs for a living and I do it fabulously." let's get into it 🎀

✨ NAME ✨

ec2deprecateimg — deprecate images in EC2 by adding tags

🦋 SYNOPSIS 🦋

ec2deprecateimg [option]

🌸 DESCRIPTION 🌸

ec2deprecateimg deprecates images in EC2 by adding tags to an image and enabling AWS image deprecation. lowkey the tagging is kept around for backwards compatibility — the tagging mechanism is an implementation based on convention. and heads up bestie: tags are not sticky, meaning they're not visible to others if the image is shared. no cap.

so here's the tag lineup, she's got three:

  • Deprecated on → the deprecation date you provided (or today's date if you provided no value) in YYYYMMDD format
  • Removal date → the deprecation date plus the deprecation period you specified
  • Replacement image → the AMI ID and name of the replacement image (optional)

and in EC2 a deprecated image gets set into a state that makes it invisible to new users. which is, like, basically equivalent to a deletion. so the tool sets the deprecation data in EC2 to the removal date set for the tag. periodt.

one more iconic detail: the image set as the replacement is removed from the list of potential images to be deprecated before any matching takes place. so the deprecation search criteria you pass with --image-name-frag or --image-name-match literally cannot match the replacement image. the replacement is off the table before the auditions even start. 🧚

✨ OPTIONS ✨

  • -a, --account ACCOUNT_NAME — specifies the account to use to connect to EC2. the account is specified in the config file ~/.ec2utils.conf, as a section with the [account-ACCOUNT_NAME] delimiter. the options of the sections are: access_key_id, secret_access_key, ssh_key_name and ssh_private_key. this lets the program connect to EC2. if the access_key_id and/or secret_access_key are not found in ~/.ec2utils.conf, the search will use the ACCOUNT_NAME to look for a matching section [profile ACCOUNT_NAME] in ~/.aws/config or [ACCOUNT_NAME] in ~/.aws/credentials.
  • --access-id AWS_ACCESS_KEY — specifies the AWS access key and overrides the value given for the account with the access_key_id in the configuration file.
  • --deprecation-date YYYYMMDD — specifies the date when the image is considered deprecated. this parameter is optional, and if it's not provided it will default to the date on which the program is executed. 🗓️
  • -d, --deprecation-period NUMBER_OF_MONTHS — specifies the number of months this image will be considered deprecated. after the deprecation period expires the image may be removed. the deprecation time is added to the deprecation date and forms the value for the Removal date tag in the format YYYYMMDD. the default deprecation period is 6 months.
  • --force — specify that any images that have already been tagged as deprecated should be tagged again with the new deprecation information. ⚠️ this overwrites the previous information and the old data is lost.
  • -n, --dry-run — the program will not perform any action. it will provide information on stdout about the actions it would perform. the "look but don't touch" of options, truly.
  • -f, --file CONFIG_FILE — specifies the configuration file to use. the default is ~/.ec2utils.conf.
  • --image-id AMI_ID — specify the AMI ID of the image to be marked as deprecated. 🚨 this option is mutually exclusive with the --image-name, --image-name-frag, and --image-name-match.
  • --image-name IMAGE_NAME — specify the name of the image to be deprecated. the program will look for an exact match of the name. this option is mutually exclusive with --image-id, --image-name-frag, and --image-name-match.
  • --image-name-frag IMAGE_NAME_FRAGMENT — specify a section of an image name for the image(s) to be deprecated. every image that matches the name fragment will be marked as deprecated. this option is mutually exclusive with --image-id, --image-name-name, and --image-name-match.
  • --image-name-match REGEX — specify a regular expression to match an image name. every image matching the regular expression will be deprecated. this option is mutually exclusive with --image-id, --image-name-name, and --image-name-frag.
  • --image-virt-type hvm|para — specify the virtualization type of the image to be deprecated. this option works in addition to --image-id, --image-name, --image-name-frag, --image-name-match. every specified condition must be satisfied in order to deprecate the image. all boxes must be ticked, no shortcuts 💅
  • --public-only — consider only images that are public as a replacement or for deprecation purposes.
  • --replacement-id AMI_ID — specify the AMI ID of the image considered to be the replacement for the image(s) that are being deprecated. the option is mutually exclusive with --replacement-name, --replacement-name-frag, and --replacement-name-match. the AMI ID and the dynamically determined image name are used in combination to form the value for the Replacement image tag in the form AMI_ID -- IMAGE_NAME. one of --replacement-id, --replacement-name, --replacement-name-frag, or --replacement-name-match, can be specified (optional).
  • --replacement-name IMAGE_NAME — specify the name of the image considered to be the replacement for the image(s) that are being deprecated. the option is mutually exclusive with the --replacement-id option. the image name and the dynamically determined AMI ID are used in combination to form the value for the Replacement image tag in the form AMI_ID -- IMAGE_NAME. one of --replacement-id, --replacement-name, --replacement-name-frag, or --replacement-name-match, can be specified (optional).
  • --replacement-name-frag IMAGE_NAME_FRAGMENT — specify a section of an image name to be considered for the replacement image. this option is mutually exclusive with --replacement-id, --replacement-name, and --replacement-name-match. the dynamically determined AMI ID and the dynamically determined image name are used in combination to form the value for the Replacement image tag in the form AMI_ID -- IMAGE_NAME. one of --replacement-id, --replacement-name, --replacement-name-frag, or --replacement-name-match, can be specified (optional).
  • --replacement-name-match REGEX — specify a regular expression to match an image name to be considered for the replacement image. this option is mutually exclusive with --replacement-id, --replacement-name, and --replacement-name-frag. the dynamically determined AMI ID and the dynamically determined image name are used in combination to form the value for the Replacement image tag in the form AMI_ID -- IMAGE_NAME. one of --replacement-id, --replacement-name, --replacement-name-frag, or --replacement-name-match, can be specified (optional).
  • -r, --regions EC2_REGIONS — a comma separated list of Amazon EC2 regions, or a single region. if no region argument is specified, all EC2 connected regions will be processed. EC2 disconnected regions have different API keys, so the specified account would not work with the disconnected regions. if a disconnected region is to be processed, specify the region explicitly on the command line, and only the region of interest along with the matching account. iykyk 🌍
  • -s, --secret-key AWS_SECRET_KEY — specifies the AWS secret access key and overrides the value given for the account with the secret_access_key in the configuration file.
  • --verbose — print extra output about the operations performed to STDOUT.
  • --version — print the version of he program 😭 (the typo is canon, it's in the original, we don't fix, we preserve 🫶)

🎀 EXAMPLE 🎀

ec2deprecateimg --account example --image-name-match v15 --image-virt-type hvm --replacement-name exampleimage_v16

this will mark all images in all connected regions that have the HVM virtualization type and match the v15 regular expression as deprecated. the replacement image will be set to the AMI ID found in the region being processed that matches the exampleimage_v16 name exactly. ate and left no crumbs 🔥

👑 AUTHOR 👑

SUSE Public Cloud Team

and that's the whole page, bestie — no skips, no cuts, every flag accounted for 🌈 this was ec2deprecateimg(1), living in the General Commands Manual, and it's a wrap 💖✨🎀

📦 where this page comes from