Documentation for Tasks for AWS 2.11 – other releases are available in the Tasks for AWS Documentation Directory.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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:

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.

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

      Don't fail for empty filter resultCheck to prevent the task failing if no matching resources are found.
      Backup SetSpecify 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 resultsee Create above
      Backup Setsee Create above
      Backup RetentionSpecify the number of backups that should be retained.
      Generated VariablesN/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 resultsee Create above
      Backup Setsee Create above
      Backup Retentionsee Delete above
      Generated Variablessee Create above

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

How-to Articles

Frequently Asked Questions (FAQ)

 

  • No labels
Atlassian®, Atlassian Bamboo®, Bitbucket®, Atlassian Crowd®, Confluence®, Jira®, Jira Service Management™, Opsgenie®, and Statuspage™ are registered trademarks of Atlassian.
Amazon Web Services™, AWS™ and the “Powered by Amazon Web Services” logo are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.

Utoolity® is a registered trademark of Utoolity GmbH.
© 2024 Utoolity GmbH. All rights reserved.