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
      

      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 from the preconfigured list. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables for example (needs to be a region code such as ap-southeast-2) .
      ...	Configure task/action specific parameters, see below ...
      AWS 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.

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

Frequently Asked Questions (FAQ)