The following macros are not currently supported in the header:
  • unmigrated-wiki-markup

Documentation for Tasks for AWS 2.8 – other releases are available in the Tasks for AWS Documentation Directory.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Using the Amazon EC2 Image task in Bamboo

Owned by Steffen Opel [Utoolity]
Last updated: 27.10.2015Version comment
2 min read

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.

 

On this page:

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

       Click here to expand...

      Task Description (Optional) Identify the purpose of the task.
      Disable this task

      Check, or clear, to selectively run this task.

      Action

      Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.

      RegionSelect the desired AWS Region. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as ap-southeast-2) - refer to How to parametrize the AWS region via a Bamboo variable for details.
      ...Configure task/action specific parameters, see below ...
      AWS Security Credentials 
      SourceSelect the source for the required AWS Security Credentials - can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector.
      Connector(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as f24e81bc-7aff-42db-86a2-7cf82e24d871) - refer to How to parametrize the AWS connector via a Bamboo variable for details.

    2. Actions supported by this task:

      Create Image(s)

      		 
      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 Image(s)

      		 
      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.

      Backup Image(s)

      		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

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Create Image(s)

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 Image(s)

N/A

Backup Image(s)

See Create above.

How-to Articles

Frequently Asked Questions (FAQ)