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.

Open

Configuration

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:

   1. Common to all tasks

   • 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 Custom Variables 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 above
     Grow Snapshot Backup Set
     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
     Volume ID	see Create above
     Filters	see Create above
     Don't fail for empty filter result	see Create 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	custom action to combine Grow and Prune, effectively capping the number of retained backups
     Volume ID	see Create above
     Filters	see Create above
     Don't fail for empty filter result	see Create above
     Backup Set	see Grow Snapshot Backup Set above
     Backup Retention	see Prune Snapshot Backup Set above

Variables

Create Snapshot(s)

Delete Snapshot(s)

N/A

Grow Snapshot Backup Set

Prune Snapshot Backup Set

N/A

Grow & Prune Snapshot Backup Set

See Grow above.

How-to Articles

Frequently Asked Questions (FAQ)