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.

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
      

       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.

   2. Actions supported by this task:
      

      Create
      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.
      Generated Variables	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
      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.
      Generated Variables	N/A
      Backup	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 result	see Create above
      Backup Set	see Create above
      Backup Retention	see Delete above
      Generated Variables	see Create above

Variables

Frequently Asked Questions (FAQ)