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:

Related Pages:

Using the Amazon EC2 Image task in Bamboo

Configuration

To configure an Amazon EBS Snapshot 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 EBS Snapshot task, or click Add Task and then AmazonEBS Snapshot Task to create a new task.

Complete the following settings:

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.
Region	Select 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
Source	Select 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.

Actions supported by this task:

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

Creating common variables for 1 resources affected by task:
... custom.aws.ec2.snapshot.resources: snap-e1aa2e71
Creating resource variables for snapshot 'snap-e1aa2e71':
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.SnapshotId: snap-e1aa2e71
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.State: completed
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.VolumeId: vol-45a6c234
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.VolumeSize: 1
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.StartTime: 20150716T080402Z
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.tags: Name;Backup Policy
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.tags.Name: taws-it-200.20150716T080402Z
... custom.aws.ec2.snapshot.resources.snap-e1aa2e71.tags.Backup Policy: taws-it-200
Creating common variables for first resource affected by task:
Creating resource variables for snapshot 'snap-e1aa2e71':
... custom.aws.ec2.snapshot.first.SnapshotId: snap-e1aa2e71
... custom.aws.ec2.snapshot.first.State: completed
... custom.aws.ec2.snapshot.first.VolumeId: vol-45a6c234
... custom.aws.ec2.snapshot.first.VolumeSize: 1
... custom.aws.ec2.snapshot.first.StartTime: 20150716T080402Z
... custom.aws.ec2.snapshot.first.tags: Name;Backup Policy
... custom.aws.ec2.snapshot.first.tags.Name: taws-it-200.20150716T080402Z
... custom.aws.ec2.snapshot.first.tags.Backup Policy: taws-it-200

Delete Snapshot(s)

N/A

Backup Snapshot(s)

See Create above.

How-to Articles

Page:
How can I take automatic Amazon EBS snapshots? — Learn about this recent AWS solution in How can I take automatic Amazon EBS snapshots?:
To help improve data protection and recovery, it is a best practice to regularly back up Amazon Elastic Compute Cloud (Amazon EC2) instances using Amazon Elastic Block Store (Amazon EBS) snapshots. Amazon EBS snapshots contain the information needed to restore your data from the time the snapshot was taken to a new Amazon EBS volume. AWS customers can use snapshots to instantiate multiple new volumes, expand the size of a volume, or move volumes across Regions and Availability Zones.
The EBS Snapshot Scheduler is an AWS-provided solution that enables customers to create an automated snapshot schedule for their Amazon EBS volumes in minutes. The solution is easy to deploy and automatically manages snapshot creation and deletion using parameters that you define. For customers who do not have a mechanism for taking regular snapshots, this solution provides an easy way to improve data protection and recoverability.
This webpage provides best practices for implementing automated backup and recovery actions on resources, as well as an overview of the EBS Snapshot Scheduler design and functionality.
[...]
AWS Answers related to Utoolity apps

Our AWS Answers collection provides a curated set of links to AWS solutions related to Utoolity apps in the Atlassian Marketplace.
Page:
How to keep only the last N images of an EC2 instance backup set
Page:
How to keep only the last N snapshots of an EBS volume backup set
Page:
How to provide temporary AWS credentials to the AWS Command Line Interface (AWS CLI) via Bamboo variables
Page:
How to target all existing resources with a tag based filter

Frequently Asked Questions (FAQ)