Using the Amazon EBS Snapshot task in Bamboo

You can use the Amazon EBS Snapshot task to create, delete or backup snapshots of Amazon Elastic Block Store (EBS) volumes; in particular, the task provides backup management with retention handling and backup set correlation.

On this page:

1 Configuration
- 1.1 Create Snapshot(s)
- 1.2 Delete Snapshot(s)
- 1.3 Grow Snapshot Backup Set
- 1.4 Prune Snapshot Backup Set
- 1.5 Grow & Prune Snapshot Backup Set
2 Variables
- 2.1 Create Snapshot(s)
- 2.2 Delete Snapshot(s)
- 2.3 Grow Snapshot Backup Set
- 2.4 Prune Snapshot Backup Set
- 2.5 Grow & Prune Snapshot Backup Set
3 How-to Articles

Related Pages:

Configuration

Alternative solution via AWS CloudFormation

AWS has published a cloud native EBS Snapshot Scheduler solution that can be deployed into a single region with the AWS CloudFormation Stack task and then apply actions to Amazon EC2 instances in any AWS Region.

Changes to action names in release 2.10.3

As of release 2.10.3, there are two new API compatible EBS Snapshot actions and the former backup oriented actions have been renamed as follows to better reflect their scope (refer to https://utoolity.atlassian.net/browse/UAA-93 for details/background):

Old action name	New action name	Notes

Old action name	New action name	Notes
N/A	Create Snapshot(s)	New in 2.10.3
N/A	Delete Snapshot(s)	New in 2.10.3
Create Snapshot(s)	Grow Snapshot Backup Set
Delete Snapshot(s)	Prune Snapshot Backup Set
Backup Snapshot(s)	Grow & Prune Snapshot 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 EBS Snapshot 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 EBS Snapshot task, or click Add Task and then AmazonEBS Snapshot Task to create a new task.

3. Complete the following settings:

a. Common to all tasks

b. Actions supported by this task:

Create Snapshot(s)

Custom Variables

In addition to the the regular Bamboo Variable Substitution/Definition, the Create Snapshot(s) action's 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 volume and add a timestamp to create the unique name ${utoolity.aws.volumeId}.${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.

Create Snapshot(s)	Custom Variables In addition to the the regular Bamboo Variable Substitution/Definition, the Create Snapshot(s) action's 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 volume and add a timestamp to create the unique name `${utoolity.aws.volumeId}.${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.
Volume ID	(Optional) Specify one or more volume IDs (semicolon separated).
Volume 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-volumes for details on available filters. Refer to Listing and Filtering Using the CLI and API for details on filter value syntax.
Description	Describe the snapshot. 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.
Tags	Specify tags in JSON format. Create unique names via custom variables.
Delete Snapshot(s)
Snapshot ID	(Optional) Specify one or more snapshot IDs (semicolon separated).
Snapshot 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-snapshots 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 Snapshot(s) above
Grow Snapshot Backup Set	Most use cases can be covered with the combined Grow & Prune Snapshot Backup Set instead, see below.
Volume ID	(Optional) Specify one or more volume 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-volumes 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.
Backup Set	Specify the name of the backup set, which determines retention correlation.
Prune Snapshot Backup Set	Most use cases can be covered with the combined Grow & Prune Snapshot Backup Set instead, see below.
Volume ID	see Create Snapshot(s) above
Filters	see Create Snapshot(s) above
Don't fail for empty filter result	see Create Snapshot(s) above
Backup Set	see Grow Snapshot Backup Set above
Backup Retention	Specify the number of backups that should be retained.
Grow & Prune Snapshot Backup Set
Volume ID	see Create Snapshot(s) above
Filters	see Create Snapshot(s) above
Don't fail for empty filter result	see Create Snapshot(s) above
Backup Set	see Grow Snapshot Backup Set above
Backup Retention	see Prune Snapshot Backup Set above

Using the Amazon EBS Snapshot task in Bamboo

Configuration

Create Snapshot(s)

Create Snapshot(s)

Delete Snapshot(s)

Grow Snapshot Backup Set

Prune Snapshot Backup Set

Grow & Prune Snapshot Backup Set