Exemplos do AWS Backup usando oAWS CLI - AWS Command Line Interface
Ações

Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.

Exemplos do AWS Backup usando oAWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Backup.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-backup-plan.

AWS CLI

Para criar um plano de backup

O exemplo create-backup-plan a seguir cria o plano de backup especificado com retenção de 35 dias.

aws backup create-backup-plan \
--backup-plan "{\"BackupPlanName\":\"Example-Backup-Plan\",\"Rules\":[{\"RuleName\":\"DailyBackups\",\"ScheduleExpression\":\"cron(0 5 ? * * *)\",\"StartWindowMinutes\":480,\"TargetBackupVaultName\":\"Default\",\"Lifecycle\":{\"DeleteAfterDays\":35}}]}"

Saída:

{
    "BackupPlanId": "1fa3895c-a7f5-484a-a371-2dd6a1a9f729",
    "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:1fa3895c-a7f5-484a-a371-2dd6a1a9f729",
    "CreationDate": 1568928754.747,
    "VersionId": "ZjQ2ZTI5YWQtZDg5Yi00MzYzLWJmZTAtMDI1MzhlMDhjYjEz"
}

Para obter mais informações, consulte Criar um plano de backup no Guia do desenvolvedor do AWS Backup.

  • Para ver detalhes da API, consulte CreateBackupPlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-backup-vault.

AWS CLI

Para criar um cofre de backup

O exemplo create-backup-vault a seguir cria um cofre de backup com o nome especificado.

aws backup create-backup-vault
    --backup-vault-name sample-vault

Este comando não produz saída. Saída:

{
    "BackupVaultName": "sample-vault",
    "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:sample-vault",
    "CreationDate": 1568928338.385
}

Para obter mais informações, consulte Criar um cofre de backup no Guia do desenvolvedor do AWS Backup.

  • Para ver detalhes da API, consulte CreateBackupVault na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-backup-plan-from-template.

AWS CLI

Para obter um plano de backup existente a partir de um modelo

O exemplo get-backup-plan-from-template a seguir obtém um plano de backup existente a partir de um modelo que especifica um backup diário com retenção de 35 dias.

aws backup get-backup-plan-from-template \
    --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa"

Saída:

{
    "BackupPlanDocument": {
        "Rules": [
            {
                "RuleName": "DailyBackups",
                "ScheduleExpression": "cron(0 5 ? * * *)",
                "StartWindowMinutes": 480,
                "Lifecycle": {
                    "DeleteAfterDays": 35
                }
            }
        ]
    }
}

Para obter mais informações, consulte Criar um plano de backup no Guia do desenvolvedor do AWS Backup.

O código de exemplo a seguir mostra como usar get-backup-plan.

AWS CLI

Para obter os detalhes de um plano de backup

O exemplo get-backup-plan a seguir exibe os detalhes do plano de backup especificado.

aws backup get-backup-plan \
    --backup-plan-id "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5"

Saída:

{
    "BackupPlan": {
        "BackupPlanName": "Example-Backup-Plan",
        "Rules": [
            {
                "RuleName": "DailyBackups",
                "TargetBackupVaultName": "Default",
                "ScheduleExpression": "cron(0 5 ? * * *)",
                "StartWindowMinutes": 480,
                "CompletionWindowMinutes": 10080,
                "Lifecycle": {
                    "DeleteAfterDays": 35
                },
                "RuleId": "70e0ccdc-e9df-4e83-82ad-c1e5a9471cc3"
            }
        ]
    },
    "BackupPlanId": "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5",
    "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5",
    "VersionId": "NjQ2ZTZkODktMGVhNy00MmQ0LWE4YjktZTkwNTQ3OTkyYTcw",
    "CreationDate": 1568926091.57
}

Para obter mais informações, consulte Criar um plano de backup no Guia do desenvolvedor do AWS Backup.

  • Para ver detalhes da API, consulte GetBackupPlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-backup-jobs.

AWS CLI

Exemplo 1: listar todas os trabalhos de backup

O exemplo list-backup-jobs a seguir retorna metadados sobre seus trabalhos de backup em sua conta da AWS.

aws backup list-backup-jobs

Saída:

{
    "BackupJobs": [
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-12345678901234567",
            "CreationDate": 1600721892.929,
            "State": "CREATED",
            "PercentDone": "0.0",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725492.929,
            "ResourceType": "EC2"
        },
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678",
            "CreationDate": 1600721724.77,
            "CompletionDate": 1600721744.488,
            "State": "COMPLETED",
            "PercentDone": "100.0",
            "BackupSizeInBytes": 71,
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725324.77,
            "ResourceType": "EFS"
        }
    ]
}

Para obter mais informações, consulte Criar um backup no Guia do desenvolvedor do AWS Backup.

Exemplo 2: listar as tarefas de backup concluídas

O exemplo list-backup-jobs a seguir retorna metadados sobre suas tarefas de backup concluídas em sua conta da AWS.

aws backup list-backup-jobs \
    --by-state COMPLETED

Saída:

{
    "BackupJobs": [
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678",
            "CreationDate": 1600721724.77,
            "CompletionDate": 1600721744.488,
            "State": "COMPLETED",
            "PercentDone": "100.0",
            "BackupSizeInBytes": 71,
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725324.77,
            "ResourceType": "EFS"
        }
    ]
}

Para obter mais informações, consulte Criar um backup no Guia do desenvolvedor do AWS Backup.

  • Para ver detalhes da API, consulte ListBackupJobs na Referência de comandos da AWS CLI.