Page Comparison

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.

Image Removed

Image Added

Panel

borderColor	#bbb
bgColor	#eeeeee

On this page:

Table of Contents

exclude	Popular.*

Panel

borderColor	#bbb
bgColor	#eeeeee

Related Pages:

Using the Amazon EBS Snapshot task in Bamboo

Configuration

Info

title	Changes to action names in release 2.10.3

As of release 2.10.3, there are two new API compatible EC2 Image actions and the former backup oriented actions have been renamed as follows to better reflect their scope (refer to

Jira Legacy

server	JIRA (utoolity.atlassian.net)
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	fac61c2e-db0a-39da-bb3c-e0dc0ef556f0
key	UAA-93

for details/background):

Old action name	New action name	Notes
N/A	Create Image(s)	New in 2.10.3
N/A	Delete Image(s)	New in 2.10.3
Create Image(s)	Grow Image Backup Set
Delete Image(s)	Prune Image Backup Set
Backup Image(s)	Grow & Prune Image Backup Set

This is a name change only and no action needs to be taken: existing tasks simply use the new names now and their configuration remains unchanged.

To configure an Amazon EC2 Image task:

Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
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.
Complete the following settings:
1. Common to all tasks
  Include Page
  _CommonTaskParametersTable
  _CommonTaskParametersTable
- Actions supported by this task:
  Create Image(s)
  
  Tip
  title Custom Variables
  In addition to the the regular Bamboo Variable Substitution/Definition, the Create

Image(s) action's Image Name, Description and Tags fields also support Injecting contextual entity variables into task configurations to ease composing unique names when targeting multiple EC2 instances at once. For example, you can refer to the source instance and add a timestamp to create the unique name ${utoolity.aws.instanceId}.${utoolity.iso8601.basicDateTime}.

These custom variables have task scope only(rather than the regular local scope aka job scope), i.e. they cease to exist when this task finishes.

Instance ID

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

Instance Filters

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

Refer to the --filters specification for describe-instances for details on available filters.
Refer to Listing and Filtering Using the CLI and API for details on filter value syntax.

Image Name

Specify the image name.

Create unique names via custom variables.

Description

Describe the image.

Create unique names via custom variables.

Don't fail for empty filter result Check to prevent the task failing if no matching resources are found.

No reboot

If 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.

When this option is used, file system integrity on the created image can't be guaranteed.

Tags

Specify tags in JSON format.

Create unique names via custom variables.

Delete Image(s)

Info

title	Snapshot Deletion

This action currently implies deletion of the backing EBS snapshots, which only works if those are not in use by another EC2 image still. Please watch/vote/comment on

Jira Legacy

server	JIRA (utoolity.atlassian.net)
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	fac61c2e-db0a-39da-bb3c-e0dc0ef556f0
key	UAA-163

if your use case requires to deregister an image as a standalone action.

Image ID

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

Image Filters

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

Refer to the --filters specification for describe-images for details on available filters.
Refer to Listing and Filtering Using the CLI and API for details on filter value syntax.

Don't fail for empty filter result see Create above

Grow Image Backup Set

Most use cases can be covered with the combined Grow & Prune Image Backup Set instead, see below.

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.

Refer to the --filters specification for describe-instances for details on available filters.
Refer to Listing and Filtering Using the CLI and API for details on filter value syntax.

Don't fail for empty filter result Check to prevent the task failing if no matching resources are found.

No reboot

If 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.

When this option is used, file system integrity on the created image can't be guaranteed.

Backup Set Specify the name of the backup set, which determines retention correlation.

Prune Image Backup Set

Most use cases can be covered with the combined Grow & Prune Image Backup Set instead, see below.

Generated Variables

Instance ID

see Create above

Filters

see Create above

Don't fail for empty filter result

see Create above

Backup Set

see Create above

Backup Retention

Specify the number of backups that should be retained.

Grow & Prune Image Backup Set

Insert excerpt

	_BackupSetInstancesNote
	_BackupSetInstancesNote
nopanel	true

Instance ID

see Create above

Filters

see Create above

Don't fail for empty filter result

see Create above

No reboot

see Create above

Backup Set

see Create above

Backup Retention

see Delete above

Variables

Include Page

	_VariablesNote
	_VariablesNote

Create Image(s)

Info
The logged `bamboo.custom.aws.ec2.image.first.tags` outputs are example tags composed via custom variables and regular Bamboo variables, i.e. you need to specify any desired tags yourself as JSON input for the Tags field.

Code Block

language	text
linenumbers	true

Creating common variables for 2 resources affected by task:
... bamboo.custom.aws.ec2.image.resources: ami-8cbdaee6;ami-eebead84
Creating resource variables for 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

8cbdaee6':
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Architecture: x86_64
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.CreationDate: 2016-04-12T23:18:41.000Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Description: Image created by TAWS-IT2103-EC22-14 from i-ccb9ab23 at 20160412T231840Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Hypervisor: xen
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.ImageId: ami-8cbdaee6
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.ImageLocation: 309600995652/taws-it-2103-i-ccb9ab23-20160412T231840Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.ImageOwnerAlias: null
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.ImageType: machine
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.KernelId: null
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Name: taws-it-2103-i-ccb9ab23-20160412T231840Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.OwnerId: 309600995652
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Platform: null
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.Public: false
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.RamdiskId: null
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.RootDeviceName: /dev/xvda
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.RootDeviceType: ebs
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.SriovNetSupport: simple
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.State: available
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.StateReason: null
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.VirtualizationType: hvm
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags: basicDate;basicTimeMilliseconds;basicTime;basicDateTimeMilliseconds;buildResultKey;instanceId;basicDateTime
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.basicDate: 20160412
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.basicTimeMilliseconds: 231840.876Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.basicTime: 231840Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.basicDateTimeMilliseconds: 20160412T231840.876Z
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.buildResultKey: TAWS-IT2103-EC22-14
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.instanceId: i-ccb9ab23
... bamboo.custom.aws.ec2.image.resources.ami-8cbdaee6.tags.basicDateTime: 20160412T231840Z
...
Creating common variables for first resource affected by task:
Creating resource variables for image 'ami-8cbdaee6':
... bamboo.custom.aws.ec2.image.first.Architecture: x86_64
... bamboo.custom.aws.ec2.image.first.CreationDate: 2016-04-12T23:18:41.000Z
... bamboo.custom.aws.ec2.image.first.Description: Image created by TAWS-IT2103-EC22-14 from i-ccb9ab23 at 20160412T231840Z
... bamboo.custom.aws.ec2.image.first.Hypervisor: xen
... bamboo.custom.aws.ec2.image.first.ImageId: ami-8cbdaee6
... bamboo.custom.aws.ec2.image.first.ImageLocation: 309600995652/taws-it-2103-i-ccb9ab23-20160412T231840Z
... bamboo.custom.aws.ec2.image.first.ImageOwnerAlias: null
... bamboo.custom.aws.ec2.image.first.ImageType: machine
... bamboo.custom.aws.ec2.image.first.KernelId: null
... bamboo.custom.aws.ec2.image.first.Name: taws-it-2103-i-ccb9ab23-20160412T231840Z
... bamboo.custom.aws.ec2.image.first.OwnerId: 309600995652
... bamboo.custom.aws.ec2.image.first.Platform: null
... bamboo.custom.aws.ec2.image.first.Public: false
... bamboo.custom.aws.ec2.image.first.RamdiskId: null
... bamboo.custom.aws.ec2.image.first.RootDeviceName: /dev/xvda
... bamboo.custom.aws.ec2.image.first.RootDeviceType: ebs
... bamboo.custom.aws.ec2.image.first.SriovNetSupport: simple
... bamboo.custom.aws.ec2.image.first.State: available
... bamboo.custom.aws.ec2.image.first.StateReason: null
... bamboo.custom.aws.ec2.image.first.VirtualizationType: hvm
... bamboo.custom.aws.ec2.image.first.tags: basicDate;basicTimeMilliseconds;basicTime;basicDateTimeMilliseconds;buildResultKey;instanceId;basicDateTime
... bamboo.custom.aws.ec2.image.first.tags.basicDate: 20160412
... bamboo.custom.aws.ec2.image.first.tags.basicTimeMilliseconds: 231840.876Z
... bamboo.custom.aws.ec2.image.first.tags.basicTime: 231840Z
... bamboo.custom.aws.ec2.image.first.tags.basicDateTimeMilliseconds: 20160412T231840.876Z
... bamboo.custom.aws.ec2.image.first.tags.buildResultKey: TAWS-IT2103-EC22-14
... bamboo.custom.aws.ec2.image.first.tags.instanceId: i-ccb9ab23
... bamboo.custom.aws.ec2.image.first.tags.basicDateTime: 20160412T231840Z

Delete Image(s)

N/A

Grow Image Backup Set

Code Block

language	text
linenumbers	true

Creating common variables for

1

2 resources affected by task:
... bamboo.custom.aws.ec2.image.resources: ami-

afdc01c4

a5bfaccf;ami-e5bead8f
Creating resource variables for image 'ami-

afdc01c4':

a5bfaccf':
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.Architecture: x86_64
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.CreationDate: 2016-04-12T23:21:30.000Z
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.Description: Created by Bamboo EC2 Image Task from i-cdb9ab22
... bamboo.custom.aws.ec2.image.resources.ami-

afdc01c4

a5bfaccf.Hypervisor: xen
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.ImageId: ami-a5bfaccf
...

ami-afdc01c4

bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.ImageLocation: 309600995652/i-cdb9ab22.20160412T232130Z
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.ImageOwnerAlias: null
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.ImageType: machine
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.KernelId: null
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.Name: i-cdb9ab22.20160412T232130Z
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.OwnerId: 309600995652
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.Platform: null
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.Public: false
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.RamdiskId: null
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.RootDeviceName: /dev/xvda
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.RootDeviceType: ebs
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.SriovNetSupport: simple
... bamboo.custom.aws.ec2.image.resources.ami-

afdc01c4

a5bfaccf.State: available
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.StateReason: null
... bamboo.custom.aws.ec2.image.resources.ami-a5bfaccf.VirtualizationType: hvm
... bamboo.custom.aws.ec2.image.resources.ami-

afdc01c4

a5bfaccf.tags: Name;Backup Policy
... bamboo.custom.aws.ec2.image.resources.ami-

afdc01c4

a5bfaccf.tags.Name: taws-it-

2.0.0.20150716T080402Z

245-1.20160412T232130Z
... bamboo.custom.aws.ec2.image.resources.ami-

afdc01c4

a5bfaccf.tags.Backup Policy: taws-it-

200

245
...
Creating common variables for first resource affected by task:
Creating resource variables for image 'ami-

afdc01c4':

a5bfaccf':
... bamboo.custom.aws.ec2.image.first.Architecture: x86_64
... bamboo.custom.aws.ec2.image.first.CreationDate: 2016-04-12T23:21:30.000Z
... bamboo.custom.aws.ec2.image.first.Description: Created by Bamboo EC2 Image Task from i-cdb9ab22
... bamboo.custom.aws.ec2.image.first.Hypervisor: xen
... bamboo.custom.aws.ec2.image.first.ImageId: ami

-afdc01c4

-a5bfaccf
... bamboo.custom.aws.ec2.image.first.ImageLocation: 309600995652/i-cdb9ab22.20160412T232130Z
... bamboo.custom.aws.ec2.image.first.ImageOwnerAlias: null
... bamboo.custom.aws.ec2.image.first.ImageType: machine
... bamboo.custom.aws.ec2.image.first.KernelId: null
... bamboo.custom.aws.ec2.image.first.Name: i-cdb9ab22.20160412T232130Z
... bamboo.custom.aws.ec2.image.first.OwnerId: 309600995652
... bamboo.custom.aws.ec2.image.first.Platform: null
... bamboo.custom.aws.ec2.image.first.Public: false
... bamboo.custom.aws.ec2.image.first.RamdiskId: null
... bamboo.custom.aws.ec2.image.first.RootDeviceName: /dev/xvda
... bamboo.custom.aws.ec2.image.first.RootDeviceType: ebs
... bamboo.custom.aws.ec2.image.first.SriovNetSupport: simple
... bamboo.custom.aws.ec2.image.first.State: available
... bamboo.custom.aws.ec2.image.first.StateReason: null
... bamboo.custom.aws.ec2.image.first.VirtualizationType: hvm
... bamboo.custom.aws.ec2.image.first.tags: Name;Backup Policy
... bamboo.custom.aws.ec2.image.first.tags.Name: taws-it-245-

2.0.0.20150716T080402Z

1.20160412T232130Z
... bamboo.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 aboveBackup RetentionSpecify the number of backups that should be retained.Generated VariablesN/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_VariablesNote

Prune Image Backup Set

N/A

Grow & Prune Image Backup Set

See Grow above.

How-to Articles

Filter by label (Content by label)

max	8
showSpace	false
sort	title
excerptType	simple
cql	label in ("aws-cli","amazon-ec2") and label in ("kb-how-to-article","kb-troubleshooting-article")

Frequently Asked Questions (FAQ)

Questionslist macro

filter	popular
ask	true
limit	8
topic	amazon-ec2

Versions Compared

Old Version 10

New Version Current

Key

Configuration

Create Image(s)

Delete Image(s)

Grow Image Backup Set

Prune Image Backup Set

Grow & Prune Image Backup Set

Variables

Create Image(s)

Delete Image(s)

Grow Image Backup Set

Delete

Backup

Variables

Prune Image Backup Set

Grow & Prune Image Backup Set

How-to Articles

Frequently Asked Questions (FAQ)