Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Moved variable code blocks from table into variables section.

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.

 

 

Panel
borderColor#bbb
bgColor#eeeeee

On this page:

Table of Contents
excludePopular.*

Panel
borderColor#bbb
bgColor#eeeeee

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

      Include Page
      _CommonTaskParametersTable
      _CommonTaskParametersTable

    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

      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.

      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

Variables

Include Page
_VariablesNote
_VariablesNote

Create

Code Block
languagetext
linenumberstrue
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 aboveDon't fail for empty filter resultsee Create aboveBackup Setsee Create aboveBackup RetentionSpecify 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 backupsInstance ID

see Create above

Filters
see Create aboveDon't fail for empty filter resultsee Create aboveBackup Setsee Create aboveBackup Retentionsee Delete aboveGenerated Variablessee Create above

Variables

Include Page_VariablesNote_VariablesNoteSee Create above.

How-to Articles

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ("aws-cli","amazon-ebs")

Frequently Asked Questions (FAQ)

Questionslist macro
filterpopular
asktrue
limit8
topicamazon-ebs