LinuxCommandLibrary

aws-backup

Manage and automate data backups

TLDR

Return BackupPlan details for a specific BackupPlanId

$ aws backup get-backup-plan --backup-plan-id [id]
copy

Create a backup plan using a specific backup plan name and backup rules
$ aws backup create-backup-plan --backup-plan [plan]
copy

Delete a specific backup plan
$ aws backup delete-backup-plan --backup-plan-id [id]
copy

List all active backup plans for the current account
$ aws backup list-backup-plans
copy

Display details about your report jobs
$ aws backup list-report-jobs
copy

SYNOPSIS

aws backup command [ options ] [ parameters ]

PARAMETERS

create-backup-plan
    Creates a backup plan.

create-backup-selection
    Creates a backup selection for a backup plan.

create-backup-vault
    Creates a backup vault.

delete-backup-plan
    Deletes a backup plan.

delete-backup-selection
    Deletes a backup selection.

delete-backup-vault
    Deletes a backup vault.

describe-backup-job
    Describes a backup job.

describe-backup-plan
    Describes a backup plan.

describe-backup-selection
    Describes a backup selection.

describe-backup-vault
    Describes a backup vault.

describe-copy-job
    Describes a copy job.

describe-global-settings
    Describes global settings.

describe-protected-resource
    Describes a protected resource.

describe-recovery-point
    Describes a recovery point.

describe-region-settings
    Describes region settings.

get-backup-plan-from-json
    Gets backup plan from JSON.

get-backup-plan-from-template
    Gets backup plan from template.

get-recovery-point-restore-metadata
    Gets recovery point restore metadata.

get-supported-resource-types
    Gets supported resource types.

list-backup-jobs
    Lists backup jobs.

list-backup-plan-templates
    Lists backup plan templates.

list-backup-plans
    Lists backup plans.

list-backup-selections
    Lists backup selections.

list-backup-vaults
    Lists backup vaults.

list-copy-jobs
    Lists copy jobs.

list-protected-resources
    Lists protected resources.

list-recovery-points-by-backup-vault
    Lists recovery points by backup vault.

list-recovery-points-by-resource
    Lists recovery points by resource.

list-restore-jobs
    Lists restore jobs.

put-backup-plan
    Puts backup plan.

put-global-settings
    Puts global settings.

put-region-settings
    Puts region settings.

restore-testing-calculate-coverage
    Calculates restore testing coverage.

restore-testing-get-coverage-report
    Gets restore testing coverage report.

restore-testing-start-restore
    Starts restore testing.

start-backup-job
    Starts a backup job.

start-copy-job
    Starts a copy job.

start-restore-job
    Starts a restore job.

stop-backup-job
    Stops a backup job.

tag-resource
    Tags a resource.

untag-resource
    Untags a resource.

update-backup-plan
    Updates a backup plan.

help
    Shows help for all commands.

version
    Shows the aws-backup version number.

DESCRIPTION

The aws-backup command is part of the AWS Command Line Interface (CLI) and provides a way to interact with the AWS Backup service from the Linux terminal.

It allows you to manage your backup plans, backup selections, recovery points, backup vaults, and other resources related to backup and recovery on AWS. Using this command, you can automate backup processes, configure backup policies, monitor backup jobs, and restore data. It's particularly useful for scripting and automation of backup tasks. The aws-backup command relies on proper AWS credentials configuration, typically via environment variables, IAM roles, or the `aws configure` command. Before using the command, ensure that your AWS CLI is properly configured to interact with your AWS account. This often involves setting up AWS access keys with sufficient permissions to manage AWS Backup resources.

CREDENTIALS

The aws-backup command requires valid AWS credentials to operate. These credentials can be provided through various methods, including:
IAM Roles: The most secure method, especially for instances in AWS.
Environment Variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_REGION.
AWS Configuration File: Located at ~/.aws/credentials and ~/.aws/config.

SEE ALSO

aws(1), aws configure(1)

Copied to clipboard