Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Moved variable code blocks from table into variables section.

You can use the Amazon EC2 Image task to create, delete or backup images (AMIs) of EBS backed Amazon Elastic Compute Cloud (Amazon EC2) instances; in particular, the task provides backup management with retention handling and backup set correlation.

 

Panel
borderColor#bbb
bgColor#eeeeee

On this page:

Table of Contents
excludePopular.*

Panel
borderColor#bbb
bgColor#eeeeee

Related Pages:

Configuration

To configure an Amazon EC2 Image task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Click the name of an existing Amazon EC2 Image task, or click Add Task and then Amazon EC2 Image Task to create a new task.
  3. Complete the following settings:

    1. Common to all tasks

      Include Page
      _CommonTaskParametersTable
      _CommonTaskParametersTable

    2. Actions supported by this task:

      Create

       
      Instance ID

      (Optional) Specify one or more instance IDs (semicolon separated).

      Filters

      (Optional) Specify resource filters in JSON format. Insert fragments from the inline Examples dialog to get started.

      Don't fail for empty filter resultCheck to prevent the task failing if no matching resources are found.
      No rebootIf unchecked (default) Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. If checked, Amazon EC2 doesn't shut down the instance before creating the image.
      • (warning) When this option is used, file system integrity on the created image can't be guaranteed.
      Backup SetSpecify the name of the backup set, which determines retention correlation.

      Delete

       
      Instance ID

      see Create above

      Filters
      see Create above
      Don't fail for empty filter resultsee Create above
      Backup Setsee Create above
      Backup RetentionSpecify the number of backups that should be retained.Generated Variables

      Backup

      custom action to combine Create and Delete, effectively capping the number of retained backups
      Instance ID

      see Create above

      Filters
      see Create above
      Don't fail for empty filter resultsee Create above
      No rebootsee Create above
      Backup Setsee Create above
      Backup Retentionsee Delete above

Variables

Include Page
_VariablesNote
_VariablesNote

Create

Code Block
languagetext
linenumberstrue
Creating image 'ami-afdc01c4' of 'i-a316b842':
... tagging resource 'ami-afdc01c4' with key 'Name' and value 'taws-it-2.0.0.20150716T080402Z' ...
... tagging resource 'ami-afdc01c4' with key 'Backup Policy' and value 'taws-it-200' ...
... images still transitioning (pending: 1) ...
... images transitioned (available: 1).
Task affects 1 resources:
... Id: ami-afdc01c4 | Status: available
Creating common variables for 1 resources affected by task:
... custom.aws.ec2.image.resources: ami-afdc01c4
Creating resource variables for image 'ami-afdc01c4':
... custom.aws.ec2.image.resources.ami-afdc01c4.ImageId: ami-afdc01c4
... custom.aws.ec2.image.resources.ami-afdc01c4.State: available
... custom.aws.ec2.image.resources.ami-afdc01c4.tags: Name;Backup Policy
... custom.aws.ec2.image.resources.ami-afdc01c4.tags.Name: taws-it-2.0.0.20150716T080402Z
... custom.aws.ec2.image.resources.ami-afdc01c4.tags.Backup Policy: taws-it-200
Creating common variables for first resource affected by task:
Creating resource variables for image 'ami-afdc01c4':
... custom.aws.ec2.image.first.ImageId: ami-afdc01c4
... custom.aws.ec2.image.first.State: available
... custom.aws.ec2.image.first.tags: Name;Backup Policy
... custom.aws.ec2.image.first.tags.Name: taws-it-2.0.0.20150716T080402Z
... custom.aws.ec2.image.first.tags.Backup Policy: taws-it-200

Delete

 Instance ID

see Create above

Filters
see Create aboveDon't fail for empty filter resultsee Create aboveBackup Setsee Create above

Backup RetentionSpecify the number of backups that should be retained.Generated Variables

N/A

Backup

custom action to combine Create and Delete, effectively capping the number of retained backupsInstance ID

see Create above

Filters
see Create aboveDon't fail for empty filter resultsee Create aboveNo rebootsee Create aboveBackup Setsee Create aboveBackup Retentionsee Delete aboveGenerated Variablessee Create above

Variables

Include Page_VariablesNote_VariablesNoteSee Create above.

How-to Articles

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ("aws-cli","amazon-ec2")

Frequently Asked Questions (FAQ)

Questionslist macro
filterpopular
asktrue
limit8
topicamazon-ec2