AWS Backup examples using AWS CLI - AWS Command Line Interface
アクション

AWS Backup examples using AWS CLI

次のコード例では、AWS Backup で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

次の例では、create-backup-plan を使用する方法を説明しています。

AWS CLI

バックアッププランを作成する方法

次の create-backup-plan の例では、35 日間の保持期間を持つ指定されたバックアッププランを作成します。

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}}]}"

出力:

{
    "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"
}

詳細については、「AWS デベロッパーガイド」の「バックアッププランの作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドレットリファレンス」の「CreateBackupPlan」を参照してください。

次の例では、create-backup-vault を使用する方法を説明しています。

AWS CLI

バックアップボールトを作成する方法

次の create-backup-vault 例では、指定された名前のバックアップボールトを作成します。

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

このコマンドでは何も出力されません。出力:

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

詳細については、「AWS デベロッパーガイド」の「バックアッププランの作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateBackupVault」を参照してください。

次の例では、get-backup-plan-from-template を使用する方法を説明しています。

AWS CLI

テンプレートから既存のバックアッププランを取得する方法

次の get-backup-plan-from-template の例では、35 日間の保持期間を持つ日次バックアップを指定するテンプレートから既存のバックアッププランを取得します。

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

出力:

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

詳細については、「AWS デベロッパーガイド」の「バックアッププランの作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「GetBackupPlanFromTemplate」を参照してください。

次の例では、get-backup-plan を使用する方法を説明しています。

AWS CLI

バックアッププランの詳細を取得する方法

次の get-backup-plan の例では、指定されたバックアッププランの詳細を表示します。

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

出力:

{
    "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
}

詳細については、「AWS デベロッパーガイド」の「バックアッププランの作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「GetBackupPlan」を参照してください。

次の例では、list-backup-jobs を使用する方法を説明しています。

AWS CLI

例 1: すべてのバックアップジョブを一覧表示する方法

次の list-backup-jobs の例では、AWS アカウントのバックアップジョブに関するメタデータを返します。

aws backup list-backup-jobs

出力:

{
    "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"
        }
    ]
}

詳細については、「AWS バックアップデベロッパーガイド」の「バックアッププランの作成」を参照してください。

例 2: 完了したバックアップジョブを一覧表示する方法

次の list-backup-jobs の例では、AWS アカウントの完了したバックアップジョブに関するメタデータを返します。

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

出力:

{
    "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"
        }
    ]
}

詳細については、「AWS バックアップデベロッパーガイド」の「バックアッププランの作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListBackupJobs」を参照してください。