aws backup - 開発者ガイド...aws backup 開発者ガイド...
TRANSCRIPT
AWS Backup開発者ガイド
AWS Backup 開発者ガイド
AWS Backup: 開発者ガイドCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's,in any manner that is likely to cause confusion among customers, or in any manner that disparages or discreditsAmazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may notbe affiliated with, connected to, or sponsored by Amazon.
AWS Backup 開発者ガイド
Table of ContentsAWS Backup とは .............................................................................................................................. 1
サポートされているリソース ........................................................................................................ 1AWS Backup の概要 ................................................................................................................... 1
一元化されたバックアップ管理 ............................................................................................. 1ポリシーベースのバックアップソリューション ....................................................................... 2タグベースのバックアップポリシー ....................................................................................... 2バックアップアクティビティモニタリング .............................................................................. 2ライフサイクル管理ポリシー ................................................................................................ 2バックアップアクセスポリシー ............................................................................................. 2
開始方法 .................................................................................................................................... 2機能の説明 ........................................................................................................................................ 4
AWS Backup と他の AWS サービスとの連携 ................................................................................. 4Amazon RDS の操作 .......................................................................................................... 4AWS Storage Gateway の操作 ............................................................................................. 5
バックアップ使用量の測定 ........................................................................................................... 5セットアップ ..................................................................................................................................... 6
AWS にサインアップ .................................................................................................................. 6IAM ユーザーを作成する .............................................................................................................. 6
開始方法 ............................................................................................................................................ 9前提条件 .................................................................................................................................... 9ステップ 1: スケジュールされたバックアップを作成する ................................................................ 10
バックアッププランを既存のものから作成する ...................................................................... 10バックアッププランにリソースを割り当てる ......................................................................... 11バックアップボールトの作成 .............................................................................................. 12次のステップ .................................................................................................................... 12
ステップ 2: オンデマンドバックアップを作成する ......................................................................... 12次のステップ .................................................................................................................... 13
ステップ 3: バックアップジョブをモニタリングする ...................................................................... 13バックアップジョブのステータスを確認する ......................................................................... 14ボールト内のすべてのバックアップの表示 ............................................................................ 14保護されたリソースの詳細の表示 ........................................................................................ 14次のステップ .................................................................................................................... 14
ステップ 4: バックアップを復元する ........................................................................................... 15次のステップ .................................................................................................................... 15
ステップ 5: クリーンアップ ....................................................................................................... 15復元された AWS リソースの削除 ........................................................................................ 16バックアッププランの削除 ................................................................................................. 16復旧ポイントの削除 .......................................................................................................... 16バックアップボールトの削除 .............................................................................................. 16
バックアッププラン .......................................................................................................................... 17バックアッププランの作成 ......................................................................................................... 17
AWS マネジメントコンソール の使用 .................................................................................. 17バックアッププランのオプションと設定 ............................................................................... 17
バックアッププランへのリソースの割り当て ................................................................................. 19バックアッププランの削除 ......................................................................................................... 19バックアッププランの更新 ......................................................................................................... 19
バックアップボールト ....................................................................................................................... 20バックアップボールトの作成 ...................................................................................................... 20
バックアップボールト名 .................................................................................................... 20KMS 暗号化マスターキー ................................................................................................... 20バックアップボールトのタグ .............................................................................................. 21
バックアップボールトと復旧ポイントに対するアクセスポリシーの設定 ............................................ 21バックアップボールトのリソースタイプへのアクセスを拒否する ............................................. 21バックアップボールトへのアクセスを拒否する ...................................................................... 22
iii
AWS Backup 開発者ガイド
バックアップボールトの復旧ポイントを削除するアクセスを拒否する ....................................... 22バックアップボールトの削除 ...................................................................................................... 23
バックアップ .................................................................................................................................... 24バックアップの作成 .................................................................................................................. 25
バックアップへのタグのコピー ........................................................................................... 25バックアップの復元 .................................................................................................................. 25
復元メタデータ ................................................................................................................. 26バックアップジョブの停止 ......................................................................................................... 26バックアップのリストの表示 ...................................................................................................... 26
保護されたリソースごとにバックアップをリストする ............................................................ 27バックアップボールトごとにバックアップをリストする ......................................................... 27
バックアップの編集 .................................................................................................................. 27セキュリティ .................................................................................................................................... 29
データ保護 ............................................................................................................................... 29AWS でのバックアップの暗号化 ......................................................................................... 30
Identity and Access Management ................................................................................................ 31認証 ................................................................................................................................ 31アクセスコントロール ....................................................................................................... 33IAM サービスロール .......................................................................................................... 42
ロギングとモニタリング ............................................................................................................ 44コンプライアンス検証 ............................................................................................................... 44弾力 ........................................................................................................................................ 45インフラストラクチャセキュリティ ............................................................................................. 45
制限 ................................................................................................................................................ 46Amazon SNS を使用してのイベントの追跡 .......................................................................................... 47
AWS Backup 通知 API .............................................................................................................. 47完了したイベント ...................................................................................................................... 47
例 : 完了したイベント ........................................................................................................ 48AWS Backup 通知コマンドの例 .................................................................................................. 49
バックアップボールトのプット通知の例 ............................................................................... 49バックアップボールト取得通知の例 ..................................................................................... 49バックアップボールトの削除通知の例 .................................................................................. 49
サービスプリンシパルとしての AWS Backup の指定 ...................................................................... 50AWS CloudTrail を使用した AWS Backup API コールのログ作成 ............................................................. 52
CloudTrail 内の AWS Backup 情報 .............................................................................................. 52AWS Backup ログファイルエントリの概要 ................................................................................... 53
AWS Backup での AWS CloudFormation テンプレートの使用 ................................................................. 56AWS Backup と AWS CloudFormation の統合 .............................................................................. 56
AWS Backup のトラブルシューティング .............................................................................................. 59一般的な問題のトラブルシューティング ....................................................................................... 59リソース作成のトラブルシューティング ....................................................................................... 59リソースの削除のトラブルシューティング .................................................................................... 60
AWS Backup API .............................................................................................................................. 61Actions .................................................................................................................................... 61
CreateBackupPlan ............................................................................................................. 63CreateBackupSelection ...................................................................................................... 66CreateBackupVault ............................................................................................................ 69DeleteBackupPlan ............................................................................................................. 72DeleteBackupSelection ...................................................................................................... 75DeleteBackupVault ............................................................................................................ 77DeleteBackupVaultAccessPolicy .......................................................................................... 79DeleteBackupVaultNotifications ........................................................................................... 81DeleteRecoveryPoint ......................................................................................................... 83DescribeBackupJob ........................................................................................................... 85DescribeBackupVault ......................................................................................................... 89DescribeCopyJob .............................................................................................................. 92DescribeProtectedResource ................................................................................................ 94
iv
AWS Backup 開発者ガイド
DescribeRecoveryPoint ...................................................................................................... 96DescribeRegionSettings .................................................................................................... 101DescribeRestoreJob ......................................................................................................... 103ExportBackupPlanTemplate .............................................................................................. 106GetBackupPlan ............................................................................................................... 108GetBackupPlanFromJSON ................................................................................................ 111GetBackupPlanFromTemplate ........................................................................................... 114GetBackupSelection ......................................................................................................... 116GetBackupVaultAccessPolicy ............................................................................................ 119GetBackupVaultNotifications .............................................................................................. 121GetRecoveryPointRestoreMetadata .................................................................................... 124GetSupportedResourceTypes ............................................................................................ 126ListBackupJobs ............................................................................................................... 128ListBackupPlans .............................................................................................................. 131ListBackupPlanTemplates ................................................................................................. 133ListBackupPlanVersions ................................................................................................... 135ListBackupSelections ....................................................................................................... 137ListBackupVaults ............................................................................................................. 139ListCopyJobs .................................................................................................................. 141ListProtectedResources .................................................................................................... 144ListRecoveryPointsByBackupVault ..................................................................................... 146ListRecoveryPointsByResource ......................................................................................... 149ListRestoreJobs .............................................................................................................. 152ListTags ......................................................................................................................... 154PutBackupVaultAccessPolicy ............................................................................................. 156PutBackupVaultNotifications .............................................................................................. 158StartBackupJob ............................................................................................................... 160StartCopyJob .................................................................................................................. 164StartRestoreJob .............................................................................................................. 167StopBackupJob ............................................................................................................... 170TagResource .................................................................................................................. 172UntagResource ............................................................................................................... 174UpdateBackupPlan .......................................................................................................... 176UpdateRecoveryPointLifecycle ........................................................................................... 179UpdateRegionSettings ...................................................................................................... 182
Data Types ............................................................................................................................ 183BackupJob ..................................................................................................................... 185BackupPlan .................................................................................................................... 188BackupPlanInput ............................................................................................................. 189BackupPlansListMember .................................................................................................. 190BackupPlanTemplatesListMember ...................................................................................... 192BackupRule .................................................................................................................... 193BackupRuleInput ............................................................................................................. 195BackupSelection .............................................................................................................. 197BackupSelectionsListMember ............................................................................................ 198BackupVaultListMember ................................................................................................... 200CalculatedLifecycle .......................................................................................................... 202Condition ....................................................................................................................... 203CopyAction ..................................................................................................................... 204CopyJob ........................................................................................................................ 205Lifecycle ........................................................................................................................ 208ProtectedResource .......................................................................................................... 209RecoveryPointByBackupVault ............................................................................................ 210RecoveryPointByResource ................................................................................................ 213RecoveryPointCreator ...................................................................................................... 215RestoreJobsListMember ................................................................................................... 216
Common Errors ...................................................................................................................... 217
v
AWS Backup 開発者ガイド
AWS の用語集 ................................................................................................................................ 220ドキュメント履歴 ............................................................................................................................ 221
vi
AWS Backup 開発者ガイドサポートされているリソース
AWS Backup とはAWS Backup はフルマネージド型のバックアップサービスであり、クラウド内およびオンプレミスのAWS のサービス間でデータのバックアップを簡単に一元化および自動化できます。AWS Backup を使用すると、バックアップポリシーを一元的に設定し、AWS リソースのバックアップアクティビティをモニタリングできます。これまでサービスごとに実行していたバックアップタスクは AWS Backup によって自動化および統合されるため、カスタムスクリプトや手動プロセスを作成する必要がなくなります。AWSBackup コンソールで数回クリックして設定するだけで、バックアップのスケジュールと保存管理を自動化するバックアップポリシーを作成できます。
AWS Backup から、フルマネージド型のポリシーベースのバックアップソリューションを得られるため、バックアップの管理がシンプルになり、ビジネスおよび規制関連のバックアップコンプライアンス要件を満たせるようになります。
サポートされているリソース以下に示しているのは、AWS Backup を使用してバックアップおよび復元できる AWS リソースです。
サポートされているサービス
サポートされているリソース
Amazon Elastic File System(Amazon EFS)
Amazon EFS ファイルシステム
Amazon DynamoDB(DynamoDB)
DynamoDB テーブル
Amazon Elastic Block Store(Amazon EBS)
Amazon EBS ボリューム
Amazon RelationalDatabase Service (AmazonRDS)
Amazon RDS データベース*
AWS Storage Gateway (ボリュームゲートウェイ)
AWS Storage Gateway ボリューム
*AWS Backup では現在、Amazon Aurora を除くすべての Amazon RDS データベースエンジンがサポートされています。
AWS Backup の概要AWS Backup には、以下の特徴と機能があります。
一元化されたバックアップ管理AWS Backup には、アプリケーションによって使用される AWS のサービス全体のバックアップを管理するための、一元化されたバックアップコンソール、一連のバックアップ API、AWS Command LineInterface (AWS CLI) が用意されています。AWS Backup では、バックアップ要件を満たすバックアップポ
1
AWS Backup 開発者ガイドポリシーベースのバックアップソリューション
リシーを一元管理できます。そのため、AWS のサービス全体の AWS リソースにそれらのポリシーを適用して、整合性とコンプライアンスを確保しながらアプリケーションデータをバックアップできます。AWSBackup の一元化されたバックアップコンソールでは、バックアップとバックアップアクティビティログが一括で表示されるため、バックアップの監査とコンプライアンスの確認が容易です。
ポリシーベースのバックアップソリューションAWS Backup では、バックアップ計画と呼ばれるバックアップポリシーを作成できます。これらのバックアップ計画を使用してバックアップ要件を定義し、使用する AWS のサービス全体で保護する AWS リソースにそれらの計画を適用します。特定のビジネスおよび規制関連のコンプライアンス要件を満たす個別のバックアップ計画を作成できます。これにより、確実に各 AWS リソースがお客様の要件に従ってバックアップされるようになります。バックアップ計画を使用すると、スケーラブルな方法で、組織全体およびアプリケーション全体にバックアップ戦略を簡単に適用できます。
タグベースのバックアップポリシーAWS Backup では、タグ付けによりバックアップ計画を AWS リソースに適用できます。タグ付けにより、すべてのアプリケーションへのバックアップ戦略の実装、すべての AWS リソースの確実なバックアップと保護が容易になります。AWS タグは、AWS リソースの整理と分類に最適です。AWS タグと統合されているため、AWS リソースのグループにバックアップ計画を迅速に適用し、整合性とコンプライアンスを確保しながらバックアップできます。
バックアップアクティビティモニタリングAWS Backup のダッシュボードでは、AWS のサービス全体でバックアップおよび復元アクティビティの監査を簡単に実施できます。AWS Backup コンソールを数回クリックするだけで、最近のバックアップジョブのステータスを表示できます。AWS のサービス全体でジョブを復元して、AWS リソースが適切に保護されていることを確認することもできます。
AWS Backup は AWS CloudTrail と統合されています。CloudTrail では、バックアップアクティビティログが一元的に表示され、リソースのバックアップ方法をすばやく簡単に監査できます。AWS Backup はAmazon Simple Notification Service (Amazon SNS) とも統合されています。そのため、バックアップが成功したときや復元が開始されたときなどに、バックアップアクティビティの通知が届きます。
ライフサイクル管理ポリシーAWS Backup では、低コストのコールドストレージ層にバックアップを保存してバックアップストレージコストを最小にしながら、コンプライアンス要件を満たすことができます。また、定義したスケジュールに従ってウォームストレージからコールドストレージにバックアップを自動的に移行させる、ライフサイクルポリシーを設定できます。
バックアップアクセスポリシーAWS Backup にはバックアップボールトに対するリソースベースのアクセスポリシーが用意されており、これらのポリシーでだれがバックアップにアクセスできるかを定義します。バックアップボールトのアクセスポリシーを定義して、そのボールト内のバックアップに対してアクセス許可を持つユーザーと実行できるアクションを定義できます。それにより、AWS のサービス全体のバックアップに対するアクセスをシンプルかつセキュアな方法で管理し、コンプライアンス要件を満たせるようになります。
開始方法AWS Backup の詳細については、まず以下のセクションを参照することをお勧めします。
2
AWS Backup 開発者ガイド開始方法
• AWS Backup: 機能の説明 (p. 4)• AWS Backup の開始方法 (p. 9)
3
AWS Backup 開発者ガイドAWS Backup と他の AWS サービスとの連携
AWS Backup: 機能の説明AWS Backup はフルマネージド型のバックアップサービスであり、AWS のサービス全体でデータのバックアップを簡単に一元化し自動化します。AWS Backup を使用して、バックアッププランと呼ばれるバックアップポリシーを作成できます。これらの計画を使用してバックアップの要件を定義できます。たとえば、データのバックアップ頻度やバックアップの保持期間などです。AWS Backup では、タグ付けするだけでバックアッププランを AWS リソースに適用できます。その後は、AWS Backup によって、定義されたバックアッププランに従って AWS リソースが自動的にバックアップされます。
次のセクションでは、AWS Backup の動作方法、実装の詳細、およびセキュリティに関する考慮事項について説明します。
トピック• AWS Backup と他の AWS サービスとの連携 (p. 4)• バックアップ使用量の測定 (p. 5)
AWS Backup と他の AWS サービスとの連携多くの AWS サービスでは、データを保護するバックアップ機能を備えています。たとえば、AmazonElastic Block Store (Amazon EBS) のスナップショット、Amazon Relational Database Service (AmazonRDS) のスナップショット、Amazon DynamoDB のバックアップ、AWS Storage Gateway のスナップショットなどです。
サービス単位のバックアップ機能もすべて、引き続き通常どおりに使用できます。たとえば、AmazonElastic Compute Cloud (Amazon EC2) API を使用して EBS ボリュームのスナップショットを作成できます。AWS Backup は、AWS クラウドとオンプレミスの両方で、AWS サービス全体でバックアップを管理する共通の手段を提供します。AWS Backup には、バックアップのスケジュール作成、保持期間の管理、バックアップのモニタリングを提供する一元化されたバックアップコンソールが用意されています。
AWS Backup は AWS サービスに既に存在するバックアップ機能を使用し、それらを一元管理する機能を実装します。たとえば、バックアッププランを作成すると、そのバックアッププランに従って自動的にバックアップを作成するときに、AWS Backup は EBS スナップショット機能を使用します。
Note
AWS Backup を使用して作成されたバックアップは、バックアップされたリソースに属する APIを使用して削除することはできません。AWS Backup API を使用した復旧ポイントの削除の詳細については、「DeleteRecoveryPoint (p. 83)」を参照してください。
AWS Backup が他の AWS のサービスと連携する方法の詳細については、次のリンクを参照してください。
• AWS Backup を Amazon EFS に使用する• DynamoDB のオンデマンドバックアップおよび復元• Amazon EBS スナップショット• Amazon RDS DB インスタンスのバックアップと復元• AWS Storage Gateway のボリュームのバックアップ
Amazon RDS の操作AWS Backup では現在、Amazon Aurora を除くすべての Amazon RDS データベースエンジンがサポートされています。
4
AWS Backup 開発者ガイドAWS Storage Gateway の操作
AWS Storage Gateway の操作Amazon EBS スナップショットは AWS Storage Gateway ボリュームに復元できます。リソースのリストアの詳細については、「バックアップ (p. 24)」を参照してください。
バックアップ使用量の測定Amazon EBS スナップショットなど既存のバックアップ機能でのバックアップの使用状況は、対応する各サービスによって測定されて課金され、料金は変わりません。AWS Backup の一元管理されたバックアップ機能を使用するために、Amazon EBS スナップショットストレージ料金など、AWS サービスから課金される既存のバックアップストレージ料金以外の追加料金はかかりません。
Amazon EFS など、AWS Backup のバックアップ機能を導入するサービスのバックアップ使用量は AWSBackup によって測定され請求されます。詳細については、「AWS Backup 料金表」を参照してください。
5
AWS Backup 開発者ガイドAWS にサインアップ
セットアップAWS Backup を初めて使用する場合は、事前に以下のタスクを実行してください。
1. AWS にサインアップ (p. 6)2. IAM ユーザーを作成する (p. 6)
AWS にサインアップアマゾン ウェブ サービス (AWS) にサインアップすると、AWS Backup を含む AWS のすべてのサービスに対して AWS アカウントが自動的にサインアップされます。料金が発生するのは、実際に使用したサービスの分のみです。
AWS Backup の使用料の詳細については、AWS Backup の料金表ページを参照してください。AWS の新規のお客様の場合、AWS Backup を無料で使い始めることができます。詳細については、「AWS 無料利用枠」を参照してください。
既に AWS アカウントをお持ちの場合は次のタスクに進んでください。AWS アカウントをお持ちでない場合は、次に説明する手順にしたがってアカウントを作成してください。
AWS アカウントを作成するには
1. https://portal.aws.amazon.com/billing/signup を開きます。2. オンラインの手順に従います。
サインアップ手順の一環として、通話呼び出しを受け取り、電話のキーパッドを用いて確認コードを入力することが求められます。
次のタスクで AWS アカウント番号が必要となるので、メモしておいてください。
IAM ユーザーを作成するAWS のサービス (AWS Backup など) では、サービスにアクセスする際に認証情報を提供する必要があります。それにより、サービスのリソースに対するアクセス許可があるかどうかをサービスが判定します。AWS では、リクエストを実行するために、AWS アカウントのルートユーザーを使用することをお勧めしません。代わりに、IAM ユーザーを作成し、そのユーザーにフルアクセスを許可します。このようなユーザーを管理者ユーザーと呼びます。AWS アカウントのルートユーザーの認証情報ではなく、管理者ユーザーの認証情報を使用して、AWS を操作し、バケットの作成、ユーザーの作成、およびアクセス許可の付与などのタスクを実行できます。詳細については、「AWS アカウントのルートユーザー認証情報と「IAM ユーザーの認証情報」(AWS 全般のリファレンス) および「IAM のベストプラクティス」(IAM ユーザーガイド) を参照してください。
AWS にサインアップしても、ご自分の IAM ユーザーをまだ作成していない場合は、IAM コンソールを使用して作成できます。
自分用の管理者ユーザーを作成し、そのユーザーを管理者グループに追加するには (コンソール)
1. AWS アカウント E メールアドレスとパスワードを使用して https://console.aws.amazon.com/iam/ でAWS アカウントのルートユーザー として IAM コンソールにサインインします。
6
AWS Backup 開発者ガイドIAM ユーザーを作成する
Note
以下のAdministratorIAMユーザーの使用に関するベストプラクティスに従い、ルートユーザー認証情報を安全な場所に保管しておくことを強くお勧めします。ルートユーザーとしてサインインして、少数のアカウントおよびサービス管理タスクのみを実行します。
2. ナビゲーションペインで [Users]、[Add user] の順に選択します。3. [ユーザー名] に「Administrator」と入力します。4. [AWS マネジメントコンソール access (アクセス)] の横にあるチェックボックスをオンにします。
[Custom password (カスタムパスワード)] を選択し、その後テキストボックスに新しいパスワードを入力します。
5. (オプション) AWS では、デフォルトで、新しいユーザーに対して初回のサインイン時に新しいパスワードを作成することが必要です。必要に応じて [User must create a new password at next sign-in(ユーザーは次回のサインイン時に新しいパスワードを作成する必要がある)] のチェックボックスをオフにして、新しいユーザーがサインインしてからパスワードをリセットできるようにできます。
6. [Next: Permissions (次へ: アクセス許可)] を選択します。7. [Set permissions (アクセス許可の設定)] で、[Add user to group (ユーザーをグループに追加)] を選択し
ます。8. [Create group] を選択します。9. [グループの作成] ダイアログボックスで、[グループ名] に「Administrators」と入力します。10. [Filter policies (フィルタポリシー)] を選択し、その後 [AWS managed -job function (AWS 管理ジョブ
の機能] を選択してテーブルのコンテンツをフィルタリングします。11. ポリシーリストで、[AdministratorAccess] のチェックボックスをオンにします。次に、[Create group]
を選択します。
Note
AdministratorAccess アクセス許可を使用して、AWS Billing and Cost Management コンソールを使用する前に、IAM ユーザーおよびロールの請求へのアクセスをアクティブ化する必要があります。これを行うには、請求コンソールへのアクセスの委任に関するチュートリアルのステップ 1 の手順に従ってください。
12. グループのリストに戻り、新しいグループのチェックボックスをオンにします。必要に応じて[Refresh] を選択し、リスト内のグループを表示します。
13. [次へ: タグ] を選択します。14. (オプション) タグをキー - 値のペアとしてアタッチして、メタデータをユーザーに追加します。IAM
でのタグの使用の詳細については、『IAM ユーザーガイド』の「IAM エンティティのタグ付け」を参照してください。
15. [Next: Review] を選択して、新しいユーザーに追加するグループメンバーシップのリストを表示します。続行する準備ができたら、[Create user] を選択します。
この同じプロセスを繰り返して新しいグループとユーザーを作成し、AWS アカウントのリソースへのアクセス権をユーザーに付与できます。ポリシーを使用して特定の AWS リソースに対するユーザーのアクセス許可を制限する方法については、「アクセス管理」と「ポリシーの例」を参照してください。
この新しい IAM ユーザーとしてサインインするには、AWS マネジメントコンソール からサインアウトします。その後、以下の URL を使用します。このとき、your_aws_account_id はハイフンを除いた AWS アカウント番号です (たとえば AWS アカウント番号が 1234-5678-9012 であれば、AWS アカウント ID は123456789012 です)。
https://your_aws_account_id.signin.aws.amazon.com/console/
作成した IAM ユーザー名とパスワードを入力します。サインインすると、ナビゲーションバーに「your_user_name@your_aws_account_id」と表示されます。
7
AWS Backup 開発者ガイドIAM ユーザーを作成する
サインページの URL に AWS アカウント ID を含めない場合は、アカウントのエイリアスを作成します。IAM ダッシュボードから [アカウントの別名を作成] をクリックし、エイリアス (会社名など) を入力します。アカウントエイリアスを作成した後、サインインするには、次の URL を使用します。
https://your_account_alias.signin.aws.amazon.com/console/
アカウントの IAM ユーザーのサインインリンクを確認するには、IAM コンソールを開き、ダッシュボードの [AWS Account Alias] の下を確認します。
8
AWS Backup 開発者ガイド前提条件
AWS Backup の開始方法このチュートリアルでは、AWS Backup を使用してリソースをバックアップおよび復元するために必要なタスクを実行する方法を説明します。
トピック• 前提条件 (p. 9)• ステップ 1: スケジュールされたバックアップを作成する (p. 10)• ステップ 2: オンデマンドバックアップを作成する (p. 12)• ステップ 3: バックアップジョブをモニタリングし、リソースが保護されていることを確認す
る (p. 13)• ステップ 4: バックアップを復元する (p. 15)• ステップ 5: リソースをクリーンアップする (p. 15)
前提条件作業を開始する前に、次の項目が揃っていることを確認してください。
• AWS アカウント。詳細については、「セットアップ (p. 6)」を参照してください。• Amazon Elastic Block Store (Amazon EBS) ボリューム。Amazon EBS の詳細については、Linux インス
タンス用 Amazon EC2 ユーザーガイドの「Amazon Elastic Block Store (Amazon EBS)」を参照してください。
Amazon EBS ボリューム作成の詳細については、Linux インスタンス用 Amazon EC2 ユーザーガイドの「Amazon EBS ボリュームの作成」を参照してください。
• バックアップするサービスに精通している必要があります。また、AWS Backup で保護する一連のリソースが必要です。
AWS Backup は現在、以下のサービスをサポートしています。• Amazon Elastic File System (Amazon EFS)
Amazon EFS の開始方法や Amazon EFS リソースの作成方法については、Amazon Elastic FileSystem ユーザーガイドの「Amazon Elastic File System の使用開始」を参照してください。
• Amazon DynamoDB
DynamoDB リソースの設定および作成については、Amazon DynamoDB 開発者ガイド の「DynamoDB の使用開始」を参照してください。
• Amazon Relational Database Service (Amazon RDS)
Amazon RDS の開始方法については、Amazon RDS ユーザーガイドの「Amazon RDS の使用開始」を参照してください。
Note
AWS Backup では現在、Amazon Aurora を除くすべての Amazon RDS データベースエンジンがサポートされています。
• AWS Storage Gateway
ボリュームゲートウェイ作成の詳細については、AWS Storage Gateway ユーザーガイドの「ボリュームゲートウェイの作成」を参照してください。
9
AWS Backup 開発者ガイドステップ 1: スケジュールされたバックアップを作成する
• リソースはすべて同じ AWS リージョンにあります。このチュートリアルでは、米国東部(バージニア北部) リージョン (us-east-1) を使用しています。
• このチュートリアルで使用するリージョンにバックアップする AWS リソースがあります。
このチュートリアルを完了するには、AWS アカウントのルートユーザーを使用して AWS マネジメントコンソールにサインインします。ただし、AWS Identity and Access Management (IAM) では、AWS アカウントのルートユーザーを使用しないことを推奨しています。代わりに、アカウントに管理者を作成し、それらの認証情報を使用してアカウントのリソースを管理します。詳細については、「セットアップ (p. 6)」を参照してください。
ステップ 1: スケジュールされたバックアップを作成する
この AWS Backup チュートリアルの最初のステップでは、バックアッププランを作成し、そこにリソースを割り当て、バックアップボールトを作成します。
作業を開始する前に、前提条件が揃っていることを確認してください。詳細については、「AWS Backupの開始方法 (p. 9)」を参照してください。
トピック• バックアッププランを既存のものから作成する (p. 10)• バックアッププランにリソースを割り当てる (p. 11)• バックアップボールトの作成 (p. 12)• 次のステップ (p. 12)
バックアッププランを既存のものから作成するバックアッププランは、Amazon DynamoDB テーブルや Amazon Elastic File System (Amazon EFS) ファイルシステムなどの AWS リソースをいつどのようにバックアップするかを定義するポリシー式です。バックアッププランにリソースを割り当てます。その場合、AWS Backup はバックアッププランに従ってそれらのリソースを自動的にバックアップし、バックアップを保持します。詳細については、「バックアッププランを使用したバックアップの管理 (p. 17)」を参照してください。
新しいバックアップ計画を作成するには、2 つの方法があります。1 つを最初から作成することも、既存のバックアップ計画に基づいて作成することもできます。この例では、AWS Backup コンソールを使用して、AWS Backup から提供されたバックアッププランを変更します。
バックアッププランを作成するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. [Start from an existing plan (既存のプランから開始)] を選択します。3. プランをリストから選択します (例: Daily-Monthly-1yr-Retention)。4. プランに名前を付けます (例: BusinessCriticalBackupPlan)。5. ルールを編集するには、ルールを選択してから [Edit (編集)] を選択します。ルールに使用する値を見
直して選択します。たとえば、[Monthly (月)] ルールのバックアップの保持期間を 1 年ではなく 3 年に延長できます。
6. バックアップボールトでは、[Default (デフォルト)] を選択します。
10
AWS Backup 開発者ガイドバックアッププランにリソースを割り当てる
7. ルールの編集が完了したら、[Create (作成)] を選択します。
要約ページが表示され、新しいバックアッププランにリソースを割り当てるオプションが提供されます。要約情報を確認したら [Assign resources (リソースを割り当てる)] を選択して次のセクションに進みます。
バックアッププランにリソースを割り当てるバックアッププランを AWS リソースに適用するには、バックアッププランを選択し、タグを使用するかリソース ID を直接リストして、リソースを割り当てます。リソースの詳細については、「バックアッププランへのリソースの割り当て (p. 19)」を参照してください。
バックアッププランに割り当てる既存の AWS リソースをまだお持ちでない場合は、この演習で使用する新しいリソースを作成してください。サポートされているサービスのいくつかまたはすべてから、複数のリソースを作成できます。Amazon EBS ボリューム、Amazon RDS インスタンス、DynamoDB テーブル、Amazon EFS ファイルシステム、AWS Storage Gateway ボリュームなどをリソースにできます。
Note
タグを使用してリソースを割り当てるには、リソースにタグを適用しておく必要があります。たとえば、この演習用のすべてのリソースに、キーと値のペア BackupPlan:MissionCriticalを使用してタグ付けします。
バックアッププランにリソースを割り当てるには
1. AWS Backup コンソールで、[Create backup plan (バックアッププランを作成)] を選択します。2. [Resource assignment name (リソース割り当て名)] リストで、リソース割り当て名を選択します。
たとえば、リソース選択に ApplicationFoo と名前を付けることができます。次に、このアプリケーションで使用されるすべての AWS リソースを割り当てます。たとえば、Amazon EBS ボリューム、Amazon EFS ファイルシステム、Amazon RDS テーブルの組み合わせなどです。
3. [IAM role (IAM ロール)] では、[Default role (デフォルトロール)] を選択します。Note
AWS Backup のデフォルトロールがアカウントに存在しない場合は、適切なアクセス許可を備えたものが自動的に作成されます。デフォルトロール以外のロールを選択した場合は、ロール名に AwsBackup またはAWSBackup のいずれかを含める必要があります。これらの文字列がないロール名には、操作を実行するための十分な権限がありません。
4. [Assign resources (リソースを割り当てる)] セクションで、[Assign by (割り当てに使用)] コントロールに [Tags (タグ)] と表示されていることを確認します。リソースにタグ付けされているキーと値を入力します (例: BackupPlan:MissionCritical)。[Add assignment (割り当てを追加)] を選択して、選択したキーと値のペアでタグ付けされたすべてのリソースを追加します。
選択されたリージョン内の、このキーと値のペアでタグ付けされたサポート対象のリソースがすべて、自動的にこのバックアッププランに割り当てられます。
5. 新しい [Assign by (割り当てに使用)] コントロールが最初のリソース割り当てに表示されたら、値をResource Id に変更します。
6. 選択に追加するリソースタイプを選択します (例: EBS)。[Volume Id (ボリューム ID)] を選択し、コントロールにこのタイプの使用可能なリソースが入力されていることを確認します。
7. リストでリソースを選択してから、[Add assignment (割り当てを追加)] を選択します。8. リソースの追加が完了したら、[Assign resources (リソースを割り当てる)] を選択します。
要約ページに戻ります。バックアッププラン、バックアップルール、リソースの割り当てに関する情報が表示されます。
11
AWS Backup 開発者ガイドバックアップボールトの作成
バックアップボールトの作成AWS Backup コンソールで自動的に作成されるデフォルトのバックアップボールトを使用する代わりに、特定のバックアップボールトを作成して、同じボールト内のバックアップのグループを保存および整理できます。
バックアップボールトの詳細については、「バックアップボールトを使用したバックアップの整理 (p. 20)」を参照してください。
バックアップボールトを作成するには
1. AWS Backup コンソールのナビゲーションペインで、[Backup vaults (バックアップボールト)] を選択します。
Note
左側にナビゲーションペインが表示されない場合は、AWS Backup コンソールの左上にあるメニューアイコンを選択して開くことができます。
2. [Create backup vault (バックアップボールトを作成)] を選択します。3. バックアップボールトの名前を入力します。中に保存するものがわかるような名前や、必要なバック
アップを検索しやすい名前をボールトを付けることができます。たとえば、FinancialBackups のような名前を付けます。
4. AWS KMS キーを選択します。作成済みのキーか、AWS Backup のデフォルトのマスターキーを使用できます。
Note
ここで指定された AWS KMS キーは、AWS Backup 暗号化をサポートするサービスのバックアップにのみ適用されます。現在は、Amazon Elastic File System (Amazon EFS) のみがサポートされます。
5. 必要に応じて、バックアップボールトを検索および識別するタグを追加します。たとえば、BackupType:Financial というタグを追加できます。
6. [Create backup vault (バックアップボールトを作成)] を選択します。7. ナビゲーションペインで [Backup vaults (バックアップボールト)] を選択して、バックアップボールト
が追加されていることを確認します。
Note
これで、バックアップルールを編集して、そのルールによって作成されるバックアップを、今作成したバックアップボールトに保存できます。
次のステップリソースのオンデマンドバックアップを作成するには、「ステップ 2: オンデマンドバックアップを作成する (p. 12)」に進みます。
ステップ 2: オンデマンドバックアップを作成するAWS Backup コンソールの [Protected resources (保護されたリソース)] に、AWS Backup によって 1 回以上バックアップされたリソースがリストされます。AWS Backup を初めて使用している場合、このページに Amazon EBS ボリュームや Amazon RDS データベースなどのリソースは表示されません。リソースがバックアッププランに割り当てられていても、バックアップがスケジュールされたバックアップジョブを1 回も実行したことがない場合も同様です。
12
AWS Backup 開発者ガイド次のステップ
このステップでは、リソースのいずれかのオンデマンドバックアップを作成します。そうすることで、そのリソースが [Protected resources (保護されたリソース)] ページにリストされます。
オンデマンドバックアップを作成するには
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[Protected resources (保護されたリソース)] を選択します。3. [Create on-demand backup (オンデマンドバックアップを作成)] を選択します。4. [Create on-demand backup (オンデマンドバックアップを作成)] ページで、バックアップするリソー
スタイプを選択します。たとえば、Amazon DynamoDB テーブルの場合は [DynamoDB] を選択します。
5. 保護するリソースの名前または ID を選択します (例: VideoMetadataTable)。6. [Create backup now (今すぐバックアップを作成)] が選択されていることを確認します。これにより、
すぐにバックアップが開始され、保存されたリソースが早く [Protected resources (保護されたリソース)] ページに表示されます。
7. コールドストレージへの移行の値 (該当する場合) および有効期限の値を指定します。
Note
コールドストレージへの移行がサポートされているのは Amazon EFS バックアップのみです。他のすべてのリソースタイプは、ウォームストレージに保存されます。[expire (有効期限)] 値はすべてのリソースタイプに対して有効です。
8. 既存のバックアップボールトを選択します。[Create new backup vault (新しいバックアップボールトを作成)] を選択すると、ボールトを作成する新しいページが開きます。完了すると、[Create on-demand backup (オンデマンドバックアップを作成)] ページに戻ります。
9. [IAM role (IAM ロール)] では、[Default role (デフォルトロール)] を選択します。
Note
AWS Backup のデフォルトロールがアカウントに存在しない場合は、適切なアクセス許可を備えたものが自動的に作成されます。
10. オンデマンドバックアップに 1 つ以上のタグを割り当てる場合は、[key (キー)] とオプションの [value(値)] を入力して、[Add tag (タグを追加)] を選択します。
11. [Create on-demand backup (オンデマンドバックアップを作成)] を選択します。これを行うと [Jobs(ジョブ)] ページに移動し、ジョブのリストが表示されます。
12. バックアップするように選択したリソースの [Backup job Id (バックアップジョブ ID)] を選択します。ジョブ詳細ページで、[Status (ステータス)] にマウスカーソルを合わせるとジョブステータスの詳細が表示されます。
次のステップステータスの確認およびバックアップアクティビティの詳細のモニタリングを行うには、「ステップ 3:バックアップジョブをモニタリングし、リソースが保護されていることを確認する (p. 13)」に進みます。
ステップ 3: バックアップジョブをモニタリングし、リソースが保護されていることを確認する
AWS Backup では、使用している AWS サービス全体の、バックアップや復元アクティビティのステータスやその他の詳細を表示できます。
13
AWS Backup 開発者ガイドバックアップジョブのステータスを確認する
AWS Backup ダッシュボードで、バックアッププランの管理、オンデマンドバックアップの作成、バックアップの復元、バックアップジョブと復元ジョブのステータスの確認を実行できます。
トピック• バックアップジョブのステータスを確認する (p. 14)• ボールト内のすべてのバックアップの表示 (p. 14)• 保護されたリソースの詳細の表示 (p. 14)• 次のステップ (p. 14)
バックアップジョブのステータスを確認するAWS Backup ダッシュボードを使用して、バックアップおよび復元アクティビティのステータスをすばやく確認できます。
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[ ダッシュボード] を選択します。3. バックアップジョブのステータスを表示するには、[Backup jobs details (バックアップジョブの詳細)]
を選択します。これにより [Jobs (ジョブ)] ページに移動します。ここでバックアップジョブと復元ジョブを含むテーブルを確認できます。
4. 時系列で表示されるジョブをフィルタリングします。たとえば、過去 24 時間以内、先週、または過去 30 日間に作成されたジョブなどです。また、歯車アイコンを選択して、各ページに表示するジョブ数を設定することもできます。
ボールト内のすべてのバックアップの表示AWS Backup の指定されたボールト内に作成されたバックアップを表示するには、次のステップに従います。
1. AWS Backup コンソールのナビゲーションペインで、[Backup vaults (バックアップボールト)] を選択します。
2. オンデマンドまたはスケジュールされたバックアップを作成するときに使用したボールトを選択して、このボールト内に作成されたすべてのバックアップを表示します。
保護されたリソースの詳細の表示[Protected resources (保護されたリソース)] ページで、AWS Backup でバックアップされたリソースの詳細を詳しく見ることができます。
1. AWS Backup コンソールのナビゲーションペインで、[Protected resources (保護されたリソース)] を選択します。
2. バックアップされている AWS リソースを表示します。リストでリソースを選択し、そのリソースのバックアップを調べます。
次のステップリソースをバックアップしたら、「ステップ 4: バックアップを復元する (p. 15)」に進みます。
14
AWS Backup 開発者ガイドステップ 4: バックアップを復元する
ステップ 4: バックアップを復元するリソースが少なくとも 1 回バックアップされると、そのリソースは保護され AWS Backup を使用して復元できるとみなされます。
AWS Backup コンソールを使用してリソースを復元するには、次のステップに従います。
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[Protected resources (保護されたリソース)] を選択します。3. リソースタイプを含む復旧ポイントのリストが、[Resource Id (リソース ID)] に表示されます。リソー
スを選択して [Backups (バックアップ)] ペインを開きます。4. リソースを復元するには、[Backups (バックアップ)] ペインで復旧ポイントの横にあるラジオボタンを
選択し、ペインの右上隅の [Restore (復元)] を選択します。5. 復元パラメータを指定します。
表示される復元パラメータは、選択したリソースタイプに固有です。たとえば、Amazon Elastic BlockStore (Amazon EBS) スナップショットを復元する場合は、このスナップショットを EBS ボリュームとして復元するか、AWS Storage Gateway ボリュームとして復元するかを指定できます。これは、AWS Backup が両方のサービスと統合されており、EBS スナップショットは EBS ボリュームまたは AWS Storage Gateway ボリュームのどちらにも復元できるためです。
6. [IAM role (IAM ロール)] で、[Default role (デフォルトロール)] を選択します。
Note
AWS Backup のデフォルトロールがアカウントに存在しない場合は、適切なアクセス許可を備えたものが自動的に作成されます。
7. [Restore resource (リソースの復元)] を選択します。
復元ジョブテーブルが表示され、ジョブを復元しようとしているというメッセージがページの上部に表示されます。このメッセージには、復元するリソースのサービスコンソールへのリンクも含まれています。そのコンソールに切り替えて、バックアップから作成した新しいリソースにアクションを行うことができます。
次のステップ結果を確認した後、保持する必要がない AWS リソースがあれば削除して、不要な料金が発生しないようにします。詳細については、「ステップ 5: リソースをクリーンアップする (p. 15)」を参照してください。
ステップ 5: リソースをクリーンアップする「AWS Backup の開始方法 (p. 9)」のすべてのタスクを実行した後は、作成した内容をクリーンアップして、不要な課金が発生しないようにします。
トピック• 復元された AWS リソースの削除 (p. 16)• バックアッププランの削除 (p. 16)• 復旧ポイントの削除 (p. 16)• バックアップボールトの削除 (p. 16)
15
AWS Backup 開発者ガイド復元された AWS リソースの削除
復元された AWS リソースの削除Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon DynamoDB テーブルなどの復旧ポイントから復元した AWS リソースを削除するには、そのサービスのコンソールを使用します。たとえば、Amazon Elastic File System (Amazon EFS) ファイルシステムを削除するには、Amazon EFS コンソールを使用します。
Note
これは、バックアップボールトに保存されている復旧ポイントではなく、復元されたリソースを指します。
バックアッププランの削除スケジュールされたバックアップを作成しない場合は、バックアッププランを削除する必要があります。プランを削除する前に、バックアッププランのすべてのリソース割り当てを削除する必要があります。
バックアッププランを削除するには、以下のステップを実行します。
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[Backup plans (バックアッププラン)] を選択します。3. [Backup plans (バックアッププラン)] ページで、削除するバックアッププランを選択します。その
バックアップの詳細ページが表示されます。4. プランのリソース割り当てを削除するには、割り当て名の横にあるラジオボタンを選択し、[Delete
(削除)] を選択します。5. バックアッププランを削除するには、ページの右上隅にある [Delete (削除)] を選択します。6. 確認ページで、プラン名を入力して [Delete (削除)] を選択します。
復旧ポイントの削除1. AWS Backup コンソールのナビゲーションペインで、[Backup vaults (バックアップボールト)] を選択
します。2. [Backup vaults (バックアップボールト)] ページで、バックアップを保存したバックアップボールトを
選択します。3. 復旧ポイントを選択し、1 つずつ削除します。
バックアップボールトの削除AWS Backup のデフォルトバックアップボールトを削除することはできません。ただし、別のバックアップボールトを作成した場合は、バックアップを削除してバックアップボールと空にします。その後、バックアップボールトを選択して、[Delete (削除)] を選択します。
16
AWS Backup 開発者ガイドバックアッププランの作成
バックアッププランを使用したバックアップの管理
AWS Backup では、バックアッププランは、Amazon DynamoDB テーブルや Amazon Elastic File System(Amazon EFS) ファイルシステムなどの AWS リソースをいつどのようにバックアップするかを定義するポリシー式です。バックアッププランにリソースを割り当てると、AWS Backup はバックアッププランに従って、それらのリソースを自動的にバックアップし、そのバックアップを維持します。さまざまなバックアップ要件を持つワークロードがある場合は、複数のバックアッププランを作成できます。
以下のセクションでは、AWS Backup のバックアップ戦略を管理する基本について説明します。
トピック• バックアッププランの作成 (p. 17)• バックアッププランへのリソースの割り当て (p. 19)• バックアッププランの削除 (p. 19)• バックアッププランの更新 (p. 19)
バックアッププランの作成作成したバックアッププランは、アカウントのプランのセットに追加されます。
AWS マネジメントコンソール の使用AWS Backup では、AWS Backup コンソールを使用した 2 とおりの開始方法が用意されています。
• 既存のプランから作成する — 既存のプランの設定に基づいて、新しいバックアッププランを作成できます。AWS Backup によって作成されたバックアッププランは、バックアップのベストプラクティスと一般的なバックアップポリシー設定に基づいています。既存のバックアッププランを開始点として選択すると、そのバックアッププランの設定が、新しいバックアッププランに自動的に入力されます。次に、バックアップ要件に応じてこれらの任意の設定を変更することができます。
• 新しいプランをゼロから構築する — バックアップ設定の詳細をそれぞれ指定して、新しいバックアッププランを作成できます。推奨されるデフォルト設定から選択できます。
バックアッププラン作成の詳細な手順については、開始方法セクションの「バックアッププランを既存のものから作成する (p. 10)」を参照してください。
バックアッププランのオプションと設定AWS Backup コンソールでバックアッププランを定義する場合は、以下のオプションを設定します。
バックアッププラン名一意のバックアッププラン名を指定する必要があります。
バックアップルールバックアッププランは、1 つ以上のバックアップルールで構成されます。各バックアップルールは以下の要素で構成されています。
17
AWS Backup 開発者ガイドバックアッププランのオプションと設定
バックアップルール名バックアップルール名では大文字と小文字が区別されます。1 ~ 63 文字の英数字またはハイフンを含める必要があります。
Backup Frequencyバックアップ頻度は、バックアップを作成する頻度を決定します。頻度は 12 時間、毎日、毎週または毎月から選択できます。毎週を選択する場合は、バックアップする曜日を指定できます。毎月を選択する場合は、月の特定の日を選択できます。
バックアップウィンドウバックアップウィンドウは、そのバックアップウィンドウの開始時刻と、ウィンドウの期間 (時間単位) で構成されます。バックアップジョブは、このウィンドウ内で開始されます。使用するバックアップウィンドウがわからない場合は、AWS Backup が推奨するデフォルトのバックアップウィンドウの使用を選択できます。デフォルトのバックアップウィンドウは、午前 5 時 (UTC 時間) 開始に設定され、8 時間続きます。
Note
cron 式を使用して、バックアップ頻度とバックアップウィンドウの開始時刻をカスタマイズできます。cron 式の詳細については、Amazon CloudWatch Events ユーザーガイドの「ルールのスケジュール式」を参照してください。
ライフサイクルライフサイクルにより、バックアップがいつコールドストレージに移行するか、およびいつ期限切れになるかが定義されます。AWS Backup は、お客様が定義するライフサイクルに従って自動的にバックアップを移行し、期限切れにします。コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、コンソール上では、「有効期限 (日数)」の設定は、「コールドへの移行 (日数)」設定の 90 日後である必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。
Note
現時点では、Amazon EFS ファイルシステムのバックアップのみをコールドストレージに移行できます。Amazon Elastic Block Store (Amazon EBS)、Amazon Relational Database Service(Amazon RDS)、Amazon DynamoDB、AWS Storage Gateway のバックアップでは、コールドストレージ式は無視されます。
バックアップボールトバックアップボールトは、バックアップを整理するコンテナです。バックアップルールによって作成されたバックアップは、バックアップルールで指定されたバックアップボールトに整理されます。バックアップボールトを使用すると、バックアップボールトでバックアップを暗号化するために使用される AWS KeyManagement Service (AWS KMS) 暗号化キーを設定したり、バックアップボールト内のバックアップへのアクセスを制御したりできます。バックアップボールトを整理しやすいように、バックアップボールトにタグを追加することもできます。デフォルトのボールトを使用しない場合は、独自のものを作成できます。バックアップボールトを作成する詳細な手順については、「バックアップボールトの作成 (p. 12)」を参照してください。
復旧ポイントに追加されるタグここにリストするタグは、バックアップ作成時に自動的に追加されます。
バックアッププランに追加されるタグこれらのタグは、バックアッププラン自体に関連付けられます。バックアッププランの整理と追跡に便利です。
18
AWS Backup 開発者ガイドバックアッププランへのリソースの割り当て
バックアッププランへのリソースの割り当てリソースをバックアッププランに割り当てると、そのリソースはバックアッププランに従って自動的にバックアップされます。そのリソースのバックアップはバックアップ計画に基づいて管理されます。リソースは、タグやリソース ID を使用して割り当てることができます。
タグを使用したリソースの割り当ては、複数のリソースをバックアップするためのシンプルでスケーラブルな方法です。リソース割り当てで指定したタグを持つすべてのリソースが、バックアッププランに割り当てられます。たとえば、タグ値 July および August を含めた場合、バックアップには選択された月でタグ付けされたすべてのリソースが含まれます。
たとえば、ミッションクリティカルなデータのバックアップ要件を満たすバックアッププランを定義し、タグキー「Classification」およびタグ値「MissionCritical」を持つリソース割り当てを作成できます。それにより、そのタグを持つすべてのリソースは、ミッションクリティカルなバックアッププランに自動的に割り当てられます。
バックアッププランへのリソース割り当ての詳細な手順については、開始方法セクションの「バックアッププランにリソースを割り当てる (p. 11)」を参照してください。
バックアッププランの削除バックアッププランは、関連付けられた選択リソースがすべて削除された後に削除できます。バックアッププランを削除すると、そのプランの現在のバージョンが削除されます。現在のバージョンと以前のバージョン (存在する場合) はまだ存在しますが、それらはコンソールの [Backup plans (バックアッププラン)]に表示されなくなります。
AWS Backup コンソールを使用してバックアッププランを削除するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. 左側にあるナビゲーションペインで、[Backup plans (バックアッププラン)] を選択します。3. リストで、バックアッププランを選択します。4. そのバックアッププランに関連付けられているリソース割り当てがあればそれを選択します。5. [Delete] を選択します。
バックアッププランの更新バックアップ計画の作成後に、プランを編集できます。たとえば、タグを追加したり、バックアップルールを追加、編集、削除したりできます。—バックアッププランに対する変更は、そのバックアッププランによって作成された既存のバックアップには影響しません。変更後に作成されるバックアップのみに適用されます。
たとえば、バックアップルールでバックアップの保持期間を更新しても、更新前に作成されたバックアップの保持期間は変わりません。今後そのルールによって作成されたバックアップには、更新された保持期間が反映されます。
AWS Backup コンソールを使用してバックアッププランを編集するには
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[Backup plans (バックアッププラン)] を選択します。3. バックアップルールを選択し、[Edit (編集)] を選択します。4. バックアップルールで、必要に応じて設定を変更し、[Save (保存)] を選択します。
19
AWS Backup 開発者ガイドバックアップボールトの作成
バックアップボールトを使用したバックアップの整理
AWS Backup では、バックアップボールトはバックアップを整理するためのコンテナです。バックアップボールトを使用すると、バックアップボールトでバックアップを暗号化するために使用される AWS KeyManagement Service (AWS KMS) 暗号化キーを設定したり、バックアップボールト内のバックアップへのアクセスを制御したりできます。バックアップグループ別に異なる暗号化キーやアクセスポリシーが必要な場合は、オプションで複数のバックアップボールトを作成できます。それ以外の場合は、すべてのバックアップをデフォルトのバックアップボールトに整理できます。
このセクションでは、AWS Backup でバックアップボールトを管理する方法の概要を示します。
トピック• バックアップボールトの作成 (p. 20)• バックアップボールトと復旧ポイントに対するアクセスポリシーの設定 (p. 21)• バックアップボールトの削除 (p. 23)
バックアップボールトの作成AWS アカウントでは、AWS リージョンあたり最大 100 個のバックアップボールトを作成できます。
バックアップボールトを作成するためのステップバイステップの説明については、入門ガイドの「バックアップボールトの作成 (p. 12)」を参照してください。
バックアップボールトを作成するときに、以下の要素を定義できます。
バックアップボールト名バックアップボールト名では大文字と小文字が区別されます。2~50 文字の英数字またはハイフンを使用する必要があります。
KMS 暗号化マスターキーAWS KMS 暗号化マスターキーは、このバックアップボールト内のバックアップを保護するために使用されます。デフォルトでは、AWS Backup によってエイリアス aws/backup のマスターキーが作成されます。そのキーを選択するか、アカウント内の他のキーを選択できます。
AWS Identity and Access Management (IAM) コンソールの [暗号化キー] タブに移動して、新しいマスター暗号化キーを作成することができます。詳細については、AWS Key Management Service DeveloperGuide の「キーの作成」を参照してください。
バックアップボールトを作成して AWS KMS 暗号化マスターキーを設定した後は、そのバックアップボールトのキーを編集できなくなります。
AWS Backup ボールトで指定された暗号化キーは、特定のリソースタイプのバックアップに適用されます。バックアップの暗号化の詳細については、「セキュリティ」セクションの「AWS でのバックアップの暗号化 (p. 30)」を参照してください。他のすべてのリソースタイプのバックアップは、ソースリソースの暗号化に使用されたキーを使用してバックアップされます。
20
AWS Backup 開発者ガイドバックアップボールトのタグ
バックアップボールトのタグこれらのタグはバックアップボールトに関連付けられており、バックアップボールトを整理して追跡するのに役立ちます。
バックアップボールトと復旧ポイントに対するアクセスポリシーの設定
AWS Backup では、バックアップボールトおよびそれらに含まれるリソースへのアクセスを制限するロール、ユーザー、グループにポリシーを割り当てることができます。ポリシーを割り当てると、バックアッププランやオンデマンドバックアップを作成するアクセス権をユーザーに付与するなどの操作が可能になりますが、作成後に復旧ポイントを削除する機能は制限されます。
ポリシーを使用してリソースへのアクセスを許可または制限する方法については、IAM ユーザーガイド の「アイデンティティベースのポリシーおよびリソースベースのポリシー」を参照してください。次のサンプルポリシーをガイドとして使用して、AWS Backup ボールトで作業しているときにリソースへのアクセスを制限できます。
さまざまなリソースタイプの復旧ポイントを識別するために使用できる Amazon リソースネーム (ARN) のリストについては、「AWS Backup リソース ARN (p. 33)」を参照して、リソース固有の復旧ポイントの ARN を確認してください。
トピック• バックアップボールトのリソースタイプへのアクセスを拒否する (p. 21)• バックアップボールトへのアクセスを拒否する (p. 22)• バックアップボールトの復旧ポイントを削除するアクセスを拒否する (p. 22)
バックアップボールトのリソースタイプへのアクセスを拒否するこのポリシーは、バックアップボールト内のすべての Amazon EBS スナップショットに対して、指定された API 操作へのアクセスを拒否します。
{ "Version": "2012-10-17", "Statement": [ { "Sid": "statement ID", "Effect": "Deny", "Principal": { "AWS": "arn:aws:iam::Account ID:role/MyRole" }, "Action": [ "backup:UpdateRecoveryPointLifecycle", "backup:DescribeRecoveryPoint", "backup:DeleteRecoveryPoint", "backup:GetRecoveryPointRestoreMetadata", "backup:StartRestoreJob", "backup:DescribeRecoveryPoint" ], "Resource": ["arn:aws:ec2:Region:::snapshot/*"] } ]
21
AWS Backup 開発者ガイドバックアップボールトへのアクセスを拒否する
}
Note
このアクセスポリシーは AWS Backup API へのユーザーアクセスのみを制御します。AmazonElastic Block Store (Amazon EBS) および Amazon Relational Database Service (Amazon RDS) スナップショットなどの一部のバックアップタイプには、それらのサービスの API を使用してもアクセスできます。バックアップへのアクセスを完全に制御するために、これらの API へのアクセスを制御する個別のアクセスポリシーを IAM で作成できます。
バックアップボールトへのアクセスを拒否するこのポリシーは、バックアップボールトを対象とする、指定された API 操作へのアクセスを拒否します。
{ "Version": "2012-10-17", "Statement": [ { "Sid": "statement ID", "Effect": "Deny", "Principal": { "AWS": "arn:aws:iam::Account ID:role/MyRole" }, "Action": [ "backup:DescribeBackupVault", "backup:DeleteBackupVault", "backup:PutBackupVaultAccessPolicy", "backup:DeleteBackupVaultAccessPolicy", "backup:GetBackupVaultAccessPolicy", "backup:StartBackupJob", "backup:GetBackupVaultNotifications", "backup:PutBackupVaultNotifications", "backup:DeleteBackupVaultNotifications", "backup:ListRecoveryPointsByBackupVault" ], "Resource": "arn:aws:backup:Region::Account ID::backup-vault:backup vault name" } ]}
バックアップボールトの復旧ポイントを削除するアクセスを拒否するボールトにアクセスできるかどうか、ボールトに保存されている復旧ポイントを削除できるかは、ユーザーに付与するアクセス許可によって決まります。
バックアップボールトに対するリソースベースのアクセスポリシーを作成して、バックアップボールト内のバックアップの削除を禁止する手順は、以下のとおりです。
バックアップボールトのリソースベースのアクセスポリシーを作成するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. 左側のナビゲーションペインで、[バックアップボールト] を選択します。3. リストからバックアップボールトを選択します。
22
AWS Backup 開発者ガイドバックアップボールトの削除
4. [Access policy (アクセスポリシー)] セクションに、以下の JSON の例を貼り付けます。このポリシーは、プリンシパルでないユーザーがターゲットバックアップコンテナー内の復旧ポイントを削除することを禁止します。ススススススス ID、ススススス ID、プリンシパルの種類 (role/MyRole) を環境の値に置き換えます。
{ "Version": "2012-10-17", "Statement": [ { "Sid": "statement ID", "Effect": "Deny", "Principal": "*", "Action": "backup:DeleteRecoveryPoint", "Resource": "*", "Condition": { "StringNotLike": { "aws:userId": [ "arn:aws:iam::Account ID:role/MyRole"" ] } } } ]}
IAM エンティティの一意の ID の取得については、「一意の ID の取得」を参照してください。
これを特定のリソースタイプに制限する場合は、"Resource": "*" の代わりに、拒否する復旧ポイントタイプを明示的に含めることができます。たとえば、Amazon EBS スナップショットにはリソースタイプを次のように変更します。
"Resource": ["arn:aws:ec2:Region:::snapshot/*"]
5. [Attach policy] を選択します。
バックアップボールトの削除AWS Backup でバックアップボールトを削除できるのは、そのボールトに関連付けられているすべてのバックアップを削除した後でのみです。
AWS Backup コンソールを使用してバックアップボールトを削除するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. 左側のナビゲーションペインで、[Backup vault (バックアップボールト)] を選択します。3. 削除するバックアップボールトを選択します。4. バックアップボールトに関連付けられているバックアップを選択して削除してから、[Delete (削除)]
を選択します。
Note
バックアップボールトを削除したら、新しいバックアップボールトを参照するようにバックアップ計画を更新します。削除されたバックアップボールトをバックアップ計画が参照していると、バックアップの作成は失敗します。
23
AWS Backup 開発者ガイド
バックアップバックアップまたは復旧ポイントとは、指定された時刻における、Amazon Elastic Block Store (AmazonEBS) ボリュームや Amazon DynamoDB テーブルなどのリソースのコンテンツを表したものです。復旧ポイントとは一般的には、Amazon EBS スナップショットや DynamoDB バックアップなどの AWS のサービスにおける異なるバックアップを指すために使用される用語です。復旧ポイントという用語とバックアップという用語は同じ意味で使用されます。
AWS Backup では、復旧ポイントは バックアップボールト に保存されます。これはビジネスニーズに応じて整理することができます。たとえば、2016 年度の財務情報を含む一連のリソースを保存できます。リソースを復元する必要がある場合は、AWS Backup コンソールまたは AWS Command Line Interface(AWS CLI) を使用して、必要なリソースを検索して復元できます。
各復旧ポイントには一意の ID があります。次の表に、AWS Backup がサポートする AWS リソースタイプの概要および対応する復旧ポイント ID の例を示します。
リソースタイプ バックアップ名 復旧ポイント ID の例
Amazon EBS ボリューム Amazon EBS スナップショット snapshot/snap-05f426fd8kdjb4224
Amazon RDS データベース* Amazon RDS スナップショット awsbackup:job-be59cf2a-2343-4402-bd8b-226993d23453
Amazon EFS ファイルシステム Amazon EFS バックアップ d99699e7-e183-477e-bfcd-ccb1c6e5455e
DynamoDB テーブル DynamoDB バックアップ table/MyDynamoDBTable/backup/01547087347000-c8b6kdk3
AWS Storage Gateway ボリューム
Amazon EBS スナップショット**
snapshot/snap-0d40e49137e31d9e0
*AWS Backup では現在、Amazon Aurora を除くすべての Amazon RDS データベースエンジンがサポートされています。
**AWS Storage Gateway ボリュームをバックアップするときに、Amazon EBS スナップショットが作成されます。このスナップショットは、Amazon EBS ボリュームまたは AWS Storage Gateway ボリュームとして復元されます。
以下のセクションでは、AWS Backup の基本的なバックアップ管理タスクの概要を説明します。
トピック• バックアップの作成 (p. 25)• バックアップの復元 (p. 25)• バックアップジョブの停止 (p. 26)• バックアップのリストの表示 (p. 26)• バックアップの編集 (p. 27)
24
AWS Backup 開発者ガイドバックアップの作成
バックアップの作成AWS Backup では、バックアップはバックアッププランによって自動的に作成されるか、オンデマンドバックアップを開始して手動で作成されます。
バックアッププランによって自動的にバックアップが作成される場合は、バックアッププランで定義されたライフサイクル設定を使用して設定されます。これらは、バックアップ計画で指定されたバックアップボールトに編成されます。また、バックアップ計画に一覧表示されているタグが付けられます。バックアッププランの詳細については、「バックアッププランを使用したバックアップの管理 (p. 17)」を参照してください。
オンデマンドバックアップを作成する場合は、作成するバックアップ用にこれらの設定を構成できます。自動または手動でバックアップが作成される場合、バックアップジョブが開始されます。各バックアップジョブには、一意の ID — たとえば D48D8717-0C9D-72DF-1F56-14E703BF2345 があります。
バックアップジョブのステータスは、AWS Backup コンソールの [Jobs (ジョブ)] ページで確認できます。復元ジョブのステータスには、[created (作成済み)]、[pending (保留中)]、[running (実行中)]、[aborting (停止中)]、[aborted (中止)]、[completed (完了)]、[failed (失敗)]、[expired (期限切れ)] があります。
バックアッププランへのリソース割り当ての詳細な手順については、「バックアッププランにリソースを割り当てる (p. 11)」を参照してください。
AWS Backup コンソールを使用してオンデマンドバックアップを作成する詳細な手順については、「ステップ 2: オンデマンドバックアップを作成する (p. 12)」を参照してください。
バックアップへのタグのコピーリソースに割り当てられたタグは、バックアップボールトに保存されている復旧ポイントに関連付けることができます。タグは、次の例外を除いて、バックアップに自動的に割り当てられます。
• DynamoDB は、バックアップへのタグの割り当てをサポートしていません。• 元々リソースに関連付けられたタグおよびバックアップ中に割り当てられたタグは、バックアップボー
ルトに保存された復旧ポイントに割り当てられます (最大 50 個)。バックアップ中に割り当てられるタグが優先され、両方のタグのセットがアルファベット順に選択されます。
• バックアップにメタデータタグを保存するために必要なリソース固有のアクセス権限の一覧については、「バックアップにタグを割り当てるのに必要なアクセス権限 (p. 35)」を参照してください。
バックアップの復元AWS Backup でバックアップを復元すると、復元するバックアップに基づいて、新しいリソースが作成されます。復元ごとに、復元パラメータを指定する必要があります。
復元パラメータは、Amazon Elastic Block Store (Amazon EBS) スナップショットを復元する場合のボリュームサイズなど、リソースタイプに固有です。AWS Backup コンソールを使用してバックアップを復元すると、サービス固有の復元パラメータが自動的に表示されます。復元ごとに、固有のジョブ ID (例:1323657E-2AA4-1D94-2C48-5D7A423E7394) を持つジョブが作成されます。—
復元ジョブのステータスは、AWS バックアップコンソールの [Jobs (ジョブ)] ページで確認できます。復元ジョブのステータスには、[created (作成済み)]、[pending (保留中)]、[running (実行中)]、[aborting (停止中)]、[aborted (中止)]、[completed (完了)]、[failed (失敗)]、[expired (期限切れ)] があります。
AWS Backup コンソールを使用したバックアップの復元の詳細な手順については、開始方法セクションの「ステップ 4: バックアップを復元する (p. 15)」を参照してください。
25
AWS Backup 開発者ガイド復元メタデータ
復元メタデータAWS CLI または AWS Backup API を使用してバックアップを復元するには、通常、リソースの設定情報を StartRestoreJob (p. 167) API に渡す必要があります。
リソースを復元するために必要な設定情報は、復元するサービスによって異なります。バックアップの作成に使用された設定メタデータは GetRecoveryPointRestoreMetadata (p. 124) を呼び出して取得できますが、リソースの復元には他の情報も必要になる場合があります。復旧ポイントの復元には、サービスごとに異なる設定値が必要になります。
Amazon EFS 復元メタデータAmazon Elastic File System (Amazon EFS) インスタンスを復元するには、次の情報が必要です。
• file-system-id — AWS Backup によってバックアップされた Amazon EFS ファイルシステムのID。GetRecoveryPointRestoreMetadata で返されます。
• Encrypted — true の場合はファイルシステムの暗号化を指定するブール値。KmsKeyId が指定される場合、Encrypted は true である必要があります。
• KmsKeyId — 復元されるファイルシステムを暗号化するために使用する AWS KMS キーを指定します。
• PerformanceMode — ファイルシステムのスループットモードを指定します。• CreationToken — リクエストの一意性 (べき等性) を確認するユーザー指定の値。• newFileSystem — true の場合は復旧ポイントが新しい Amazon EFS ファイルシステムに復元される
ことを指定するブール値。
Amazon EFS 設定値の詳細については、「create-file-system」を参照してください。
バックアップジョブの停止AWS Backup でバックアップジョブが開始された後に停止できます。これを行うと、バックアップは作成されず、バックアップジョブのレコードが [aborted (中止)] のステータスで保持されます。
AWS Backup コンソールを使用してバックアップジョブを中止するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. 左側のナビゲーションペインで、[Jobs (ジョブ)] を選択します。3. 停止するバックアップジョブを選択します。4. バックアップジョブの詳細ペインで、[Stop (停止)] を選択します。
バックアップのリストの表示AWS Backup コンソールを使用してバックアップのリストを表示する方法は 2 つあります。特定の AWSリソースに関連付けられたバックアップを表示できます。または、単一のバックアップボールト内に整理された、複数の AWS リソースや異なるリソースタイプにまたがるすべてのバックアップを表示することもできます。
トピック• 保護されたリソースごとにバックアップをリストする (p. 27)• バックアップボールトごとにバックアップをリストする (p. 27)
26
AWS Backup 開発者ガイド保護されたリソースごとにバックアップをリストする
保護されたリソースごとにバックアップをリストするAWS Backup コンソールで特定のリソースのバックアップのリストを表示するには、次のステップに従います。
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. ナビゲーションペインで、[Protected resources (保護されたリソース)] を選択します。3. リスト内の保護されたリソースを選択して、バックアップのリストを表示します。AWS Backup に
よってバックアップされたリソースのみが、[Protected resources (保護されたリソース)] の下にリストされます。
AWS Backup によって作成されていないものも含めて、そのリソースのすべてのバックアップを表示できます。このビューから、バックアップを選択して復元することもできます。
バックアップボールトごとにバックアップをリストするバックアップボールトに整理されたバックアップのリストを表示するには、以下のステップに従います。
1. AWS Backup コンソール (https://console.aws.amazon.com/backup) を開きます。2. ナビゲーションペインで、[Backup vaults (バックアップボールト)] を選択します。3. [Backups (バックアップ)] セクションで、このバックアップボールトに整理されたすべてのバックアッ
プのリストを表示します。このビューでは、バックアップを選択して編集、削除、復元できます。
バックアップの編集AWS Backup を使用してバックアップを作成した後、バックアップのライフサイクルまたはタグを変更できます。ライフサイクルにより、バックアップがいつコールドストレージに移行するか、およびいつ期限切れになるかが定義されます。AWS Backup は、お客様が定義するライフサイクルに従って自動的にバックアップを移行し、期限切れにします。
Note
AWS Backup を使用したバックアップのタグの編集は、Amazon Elastic File System (AmazonEFS) ファイルシステムのバックアップでのみサポートされています。他のサービスのバックアップのタグは、サービスのコンソールまたは API を使用して編集できます。
コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、「有効期限 (日数)」の設定は、「コールドへの移行 (日数)」設定の 90 日後である必要があります。「コールドへの移行 (日数)」設定を更新する場合、値はバックアップの経過時間 + 1 日以上にする必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。
次の例では、バックアップのライフサイクルを更新する方法について説明します。
バックアップのライフサイクルを編集するには
1. AWS マネジメントコンソールにサインインして、https://console.aws.amazon.com/backup で AWSBackup コンソールを開きます。
2. ナビゲーションペインで、[Backup vaults (バックアップボールト)] を選択します。3. [Backups (バックアップ)] セクションで、バックアップを選択します。
27
AWS Backup 開発者ガイドバックアップの編集
4. バックアップ詳細ページで、[Edit (編集)] を選択します。5. ライフサイクル設定を構成して、[Save (保存)] を選択します。
28
AWS Backup 開発者ガイドデータ保護
AWS Backup でのセキュリティAWS では、クラウドのセキュリティが最優先事項です。AWS のお客様は、セキュリティを最も重視する組織の要件を満たすように構築されたデータセンターとネットワークアーキテクチャーから利点を得られます。
セキュリティは、AWS とお客様の間の共有責任です。共有責任モデルでは、これをクラウドのセキュリティおよびクラウド内のセキュリティとして説明しています。
• クラウドのセキュリティ – AWS は、AWS クラウド内で AWS サービスを実行するインフラストラクチャを保護する責任を担います。また、AWS は、使用するサービスを安全に提供します。AWS コンプライアンスプログラムの一環として、サードパーティーの監査が定期的にセキュリティの有効性をテストおよび検証しています。AWS Backup に適用するコンプライアンスプログラムの詳細については、「コンプライアンスプログラムによる AWS 対象範囲内のサービス」を参照してください。
• クラウド内のセキュリティ – お客様の責任はお客様が使用する AWS のサービスによって決まります。また、お客様は、お客様のデータの機密性、企業の要件、および適用可能な法律および規制などの他の要因についても責任を担います。
このドキュメントは、AWS Backup を使用する際に共有責任モデルを適用する方法を理解するのに役立ちます。以下のトピックでは、セキュリティおよびコンプライアンスの目的を達成するために AWS Backupを設定する方法を示します。また、AWS Backup リソースのモニタリングや保護に役立つ他の AWS サービスの使用方法についても説明します。
トピック• AWS Backup でのデータ保護 (p. 29)• AWS Backup での Identity and Access Management (p. 31)• AWS Backup でのログ記録とモニタリング (p. 44)• AWS Backup のコンプライアンス検証 (p. 44)• AWS Backup の耐障害性 (p. 45)• AWS Backup のインフラストラクチャセキュリティ (p. 45)
AWS Backup でのデータ保護AWS Backup は、データ保護の規制やガイドラインを含む AWS 責任共有モデルに準拠しています。AWSは、すべての AWS のサービスを実行するグローバルなインフラストラクチャを保護する責任を担います。AWS は、カスタマーコンテンツおよび個人データを取り扱うためのセキュリティ設定の統制など、このインフラストラクチャ上でホストされるデータ管理を維持します。データコントローラーまたはデータプロセッサーとして機能する、AWS のお客様および AWS Partner Network (APN) パートナーは、AWS クラウドに保存された個人データに対する責任を担います。
データ保護の目的で、AWS アカウントの認証情報を保護し、個々のユーザーアカウントを AWS Identityand Access Management (IAM) で設定することをお勧めします。このようにすることで、それぞれの職務を遂行するために必要なアクセス権限のみを各ユーザーに付与することができます。また、以下の方法でデータを保護することをお勧めします。
• 各アカウントで多要素認証 (MFA) を使用します。• Secure Sockets Layer (SSL)/Transport Layer Security (TLS) を使用して AWS リソースと通信します。
• AWS 暗号化ソリューションを、AWS サービス内のすべてのデフォルトのセキュリティ管理と一緒に使用します。
29
AWS Backup 開発者ガイドAWS でのバックアップの暗号化
顧客のアカウント番号などの機密の識別情報は、[名前] フィールドなどの自由形式のフィールドに配置しないことを強くお勧めします。これは、コンソール、API、AWS CLI、または AWS で AWS Backup または他の AWS サービスを使用する場合も同様です。AWS Backup または他のサービスに入力したデータはすべて、診断ログの内容として取得される可能性があります。外部サーバーへの URL を指定するときは、そのサーバーへのリクエストを検証するための認証情報を URL に含めないでください。
データ保護の詳細については、AWS セキュリティブログのブログ投稿「AWS の責任共有モデルとGDPR」を参照してください。
AWS でのバックアップの暗号化AWS でのすべてのバックアップは AWS KMS 管理キー (SSE-KMS) を使用して暗号化されます。暗号化を設定する方法はリソースタイプによって異なります。特定のリソースタイプでは、ソースリソースの暗号化に使用したキーとは別の暗号化キーでバックアップを暗号化する機能がサポートされています。この機能により、バックアップをさらに強固に保護できます。
以下の表では、サポートされている各リソースタイプ、バックアップ用の暗号化の設定方法を示しています。また、バックアップ用の独立した暗号化がサポートされているかどうかを示しています。
リソースタイプ 暗号化を設定する方法 独立したバックアップ暗号化
Amazon Elastic Block Store(Amazon EBS)
Amazon EBS スナップショットは、ソース EBS ボリュームの暗号化に使用されたものと同じ暗号化キーで自動的に暗号化されます。暗号化されていない EBSボリュームのスナップショットは引き続き暗号されません。
サポート外
Amazon Relational DatabaseService (Amazon RDS)
Amazon RDS スナップショットは、ソース Amazon RDS データベースの暗号化に使用されたものと同じ暗号化キーで自動的に暗号化されます。暗号化されていない Amazon RDS データベースのスナップショットは引き続き暗号化されません。
Note
AWS Backup では現在、Amazon Aurora を除くすべての AmazonRDS データベースエンジンがサポートされています。
サポート外
Amazon Elastic File System(Amazon EFS)
Amazon EFS バックアップは常に暗号化されます。Amazon EFSバックアップ用の AWS KMS暗号化キーは、Amazon EFSバックアップが保存される AWSBackup ボールトに設定されます。
サポート対象
Amazon DynamoDB DynamoDB バックアップは、常に暗号化されます。DynamoDBバックアップは、ソース
サポート外
30
AWS Backup 開発者ガイドIdentity and Access Management
リソースタイプ 暗号化を設定する方法 独立したバックアップ暗号化DynamoDB テーブルの暗号化に使用されたものと同じ暗号化キーで自動的に暗号化されます。暗号化されていないDynamoDB テーブルのスナップショットは引き続き暗号化されません。
AWS Storage Gateway AWS Storage Gateway スナップショットは、ソース AWSStorage Gateway ボリュームの暗号化に使用されたものと同じ暗号化キーで自動的に暗号化されます。暗号化されていないAWS Storage Gateway ボリュームのスナップショットは引き続き暗号化されません。
サポート外
AWS Backup がサポートしている各サービスのバックアップ暗号化の詳細については、以下のトピックを参照してください。
• AWS Storage Gateway ユーザーガイドの「AWS Key Management Service を使用したデータの暗号化」
• Amazon RDS ユーザーガイド の「Amazon RDS リソースの暗号化」• Amazon DynamoDB 開発者ガイド の「保管時の Amazon DynamoDB 暗号化」
AWS Backup での Identity and AccessManagement
AWS Backup へのアクセスには、認証情報が必要です。これらの認証情報には、Amazon DynamoDB データベースまたは Amazon EBS ボリュームなどの AWS リソースへのアクセス権限が必要です。以下のセクションでは、AWS Identity and Access Management (IAM) と AWS Backup を使用してリソースへのアクセスを保護する方法について詳しく説明します。
トピック• 認証 (p. 31)• アクセスコントロール (p. 33)• IAM サービスロール (p. 42)
認証バックアップを行う AWS Backup または AWS のサービスにアクセスするには、AWS がお客様からのリクエストの認証に使用できる認証情報が必要です。AWS には、次のタイプのアイデンティティでアクセスできます。
• AWS アカウントのルートユーザー – AWS にサインアップするときは、AWS アカウントに関連付けられた E メールアドレスとパスワードを指定します。これは AWS アカウントのルートユーザーです。この認証情報はすべての AWS リソースに対する完全なアクセスを提供します。
31
AWS Backup 開発者ガイド認証
Important
セキュリティ上の理由から、管理者を作成する場合にのみルートユーザーを使用することをお勧めします。管理者は、AWS アカウントに対する完全な権限を持つ IAM ユーザーです。その後、この管理者ユーザーを使用して、制限されたアクセス権限を持つ他の IAM ユーザーとロールを作成できます。詳細については、IAM ユーザーガイド の「IAM のベストプラクティス」と「最初の IAM 管理者のユーザーおよびグループの作成」を参照してください。
• IAM ユーザー – IAM ユーザーは、AWS アカウント内で特定のカスタムアクセス許可 (バックアップ保存用のバックアップボールトを作成するためのアクセス許可など) を持つアイデンティティです。IAM のユーザー名とパスワードを使用して、AWS マネジメントコンソール、AWS ディスカッションフォーラム、AWS Support Center などのセキュリティ保護された AWS ウェブページにサインインできます。
ユーザー名とパスワードに加えて、各ユーザーのアクセスキーを生成することもできます。いくつかある SDK の 1 つまたは AWS Command Line Interface (AWS CLI) を使用してプログラムで AWS サービスにアクセスするときに、これらのキーを使用できます。SDK と AWS CLI ツールでは、アクセスキーを使用してリクエストが暗号で署名されます。AWS ツールを使用しない場合は、リクエストに自分で署名する必要があります。リクエストの認証の詳細については、『AWS General Reference』の「署名バージョン 4 の署名プロセス」を参照してください。
• IAM ロール – IAM ロールは、特定のアクセス許可を持ち、アカウントで作成できる、もう 1 つの IAM ア
イデンティティです。これは IAM ユーザーに似ていますが、特定のユーザーに関連付けられていません。IAM ロールでは、AWS のサービスおよびリソースにアクセスできる一時的なアクセスキーを取得することができます。IAM ロールと一時的な認証情報は、次の状況で役立ちます。
• フェデレーティッドユーザーアクセス – IAM ユーザーを作成するのではなく、AWS Directory
Service、エンタープライズユーザーディレクトリ、またはウェブアイデンティティプロバイダーの既存のユーザーアイデンティティを使用することもできます。このようなユーザーはフェデレーティッドユーザーと呼ばれます。AWS では、ID プロバイダーを通じてアクセスがリクエストされたとき、フェデレーティッドユーザーにロールを割り当てます。フェデレーティッドユーザーの詳細については、『IAM ユーザーガイド』の「フェデレーティッドユーザーとロール」を参照してください。
• クロスアカウント管理 – お客様のアカウントで IAM ロールを使用して、アカウントのリソースを管
理するためのアクセス許可を別の AWS アカウントに付与できます。この例については、『IAM ユーザーガイド』の「チュートリアル: AWS アカウント間の IAM ロールを使用したアクセスの委任」を参照してください。
• AWS サービスアクセス – お客様のアカウントで IAM ロールを使用して、アカウントのリソースに対
するアクセス許可を AWS サービスに付与できます。詳細については、IAM ユーザーガイド の「AWSサービスにアクセス許可を委任するロールの作成」を参照してください。
• Amazon Elastic Compute Cloud (Amazon EC2) で実行されているアプリケーション – IAM ロールを
使用して、Amazon EC2 インスタンスで実行されて AWS API リクエストを行うアプリケーションの一時的な認証情報を管理できます。これは、EC2 インスタンス内でのアクセスキーの保存に推奨されます。AWS ロールを EC2 インスタンスに割り当て、そのすべてのアプリケーションで使用できるようにするには、インスタンスにアタッチされたインスタンスプロファイルを作成します。インスタンスプロファイルにはロールが含まれ、EC2 インスタンスで実行されるプログラムは一時認証情報を取得することができます。詳細については、IAM ユーザーガイド の「IAM ロールを使用して、AmazonEC2 インスタンスで実行されるアプリケーションにアクセス許可を付与する」を参照してください。
32
AWS Backup 開発者ガイドアクセスコントロール
アクセスコントロールリクエストを認証するための有効な認証情報を用意できても、適切なアクセス許可がない限り、バックアップボールトなどの AWS Backup リソースにアクセスすることはできません。Amazon Elastic BlockStore (Amazon EBS) ボリュームなどの AWS リソースをバックアップすることもできません。
すべての AWS リソースは AWS アカウントによって所有され、となり、リソースの作成またはアクセスは、アクセス権限のポリシーによって管理されます。アカウント管理者は、AWS Identity and AccessManagement (IAM) ID (ユーザー、グループ、ロール) にアクセス権限ポリシーをアタッチできます。また、一部のサービスでは、アクセス権限ポリシーをリソースにアタッチすることができます。
Note
アカウント管理者 (または管理者ユーザー) は、管理者権限を持つユーザーです。詳細については、IAM ユーザーガイドの「IAM のベストプラクティス」を参照してください。
アクセス権限を付与する場合、アクセス権限を取得するユーザー、取得するアクセス権限の対象となるリソース、およびそれらのリソースに対して許可される特定のアクションを決定します。
以下のセクションでは、アクセスポリシーのしくみと、それらのポリシーを使用してバックアップを保護する方法について説明します。
トピック• リソースおよびオペレーション (p. 33)• リソースの所有権 (p. 34)• ポリシー要素の指定 : アクション、効果、プリンシパル (p. 34)• ポリシーでの条件の指定 (p. 35)• AWS Backup API のアクセス許可: アクション、リソース、条件リファレンス (p. 35)• アクセスポリシー (p. 35)• 管理ポリシー (p. 36)
リソースおよびオペレーションリソースは、サービス内に存在するオブジェクトです。AWS Backup リソースとしては、バックアップ計画、バックアップボールト、バックアップなどがあります。バックアップは、AWS に存在するさまざまなタイプのバックアップリソースを指す一般用語です。たとえば、Amazon EBS スナップショット、Amazon Relational Database Service (Amazon RDS) スナップショット、Amazon DynamoDB バックアップはすべて、バックアップリソースのタイプです。
AWS Backup では、バックアップは復旧ポイントとも呼ばれます。AWS Backup を使用するときは、Amazon EBS ボリュームや DynamoDB テーブルなど、保護しようとしている他の AWS のサービスのリソースも使用します。これらのリソースには、一意の Amazon リソースネーム (ARN) が関連付けられています。ARN は AWS リソースを一意に識別します。IAM ポリシーや API コールなど、すべての AWSでリソースを明確に指定する必要がある場合は、ARN が必要です。
以下の表では、リソース、サブリソース、ARN 形式を示しています。
AWS Backup リソース ARN
リソースタイプ ARN 形式
バックアップ計画 arn:aws:backup:region:account-id:backup-plan:*
バックアップボールト arn:aws:backup:region:account-id:backup-vault:*
Amazon EBS の復旧ポイント
arn:aws:ec2:region::snapshot/*
33
AWS Backup 開発者ガイドアクセスコントロール
リソースタイプ ARN 形式
Amazon EFS の復旧ポイント
arn:aws:backup:region:account-id:recovery-point:*
Amazon RDS の復旧ポイント
arn:aws:rds:region:account-id::snapshot:awsbackup:*
AWS Storage Gateway の復旧ポイント
arn:aws:ec2:region::snapshot/*
DynamoDB の復旧ポイント arn:aws:dynamodb:region:account-id::table/*/backup/*
AWS Backup では、AWS Backup リソースを操作する一連のオペレーションが用意されています。使用できるオペレーションのリストについては、AWS Backup の「Actions (p. 61)」を参照してください。
リソースの所有権AWS アカウントは、誰がリソースを作成したかにかかわらず、アカウントで作成されたリソースを所有します。具体的には、リソース所有者は、リソースの作成リクエストを認証するプリンシパルエンティティ(AWS アカウントルートユーザー、IAM ユーザー、または IAM ロール) の AWS アカウントです。以下の例では、このしくみを示しています。
• AWS アカウントのルートユーザー認証情報を使用してバックアップボールトを作成する場合、そのAWS アカウントはボールトの所有者です。
• AWS アカウントに IAM ユーザーを作成し、そのユーザーにバックアップボールトを作成するためのアクセス許可を付与する場合、そのユーザーはバックアップボールトを作成できます。ただし、バックアップボールトリソースを所有しているのは、このユーザーが属する AWS アカウントです。
• バックアップボールトを作成するためのアクセス許可を持つ AWS アカウントに IAM ロールを作成する場合、ロールを引き受けることのできるいずれのユーザーもボールトを作成できます。ただし、バックアップボールトリソースを所有しているのは、このロールが属する AWS アカウントです。
ポリシー要素の指定 : アクション、効果、プリンシパルこのサービスは、AWS Backup の各リソース (「リソースおよびオペレーション (p. 33)」を参照) に対して、一連の API オペレーション (「Actions (p. 61)」を参照) を定義します。これらの API オペレーションに対するアクセス許可を付与するために、AWS Backup では、ポリシーに指定できる一連のアクションが定義されています。1 つの API オペレーションの実行で、複数のアクションのアクセス権限が必要になる場合があります。
以下は、最も基本的なポリシーの要素です。
• リソース – ポリシーで Amazon リソースネーム (ARN) を使用して、ポリシーを適用するリソースを識別します。詳細については、「リソースおよびオペレーション (p. 33)」を参照してください。
• アクション – アクションのキーワードを使用して、許可または拒否するリソースオペレーションを識別します。
• 効果 – ユーザーが特定のアクションをリクエストするときの効果を指定します。これは許可または拒否のいずれかになります。リソースへのアクセスを明示的に許可していない場合、アクセスは暗黙的に拒否されます。また、明示的にリソースへのアクセスを拒否すると、別のポリシーによってアクセスが許可されている場合でも、ユーザーはそのリソースにアクセスできなくなります。
• プリンシパル – アイデンティティベースのポリシー (IAM ポリシー) で、ポリシーがアタッチされているユーザーが黙示的なプリンシパルとなります。リソースベースのポリシーでは、権限 (リソースベースのポリシーにのみ適用) を受け取りたいユーザー、アカウント、サービス、またはその他のエンティティを指定します。
34
AWS Backup 開発者ガイドアクセスコントロール
IAM ポリシーの構文と説明についての詳細については、IAM ユーザーガイド の「IAM JSON ポリシーのリファレンス」を参照してください。
すべての AWS Backup API アクションを示す表については、「AWS Backup API のアクセス許可: アクション、リソース、条件リファレンス (p. 35)」を参照してください。
ポリシーでの条件の指定アクセス権限を付与するとき、IAM ポリシー言語を使用して、ポリシーが有効になる必要がある条件を指定できます。たとえば、特定の日付の後にのみ適用されるポリシーが必要になる場合があります。ポリシー言語での条件の指定の詳細については、『IAM ユーザーガイド』の「条件」を参照してください。
条件を表すには、あらかじめ定義された条件キーを使用します。AWS Backup に固有の条件キーはありません。ただし、AWS 全体の条件キーがあり、必要に応じて使用できます。AWS 全体の条件キーの完全なリストについては、IAM ユーザーガイド の「AWS グローバル条件コンテキストキー」を参照してください。
Note
AWS Backup では、いずれのアクションのアクセスポリシーでもタグまたは条件コンテキストキーはサポートされていません。
AWS Backup API のアクセス許可: アクション、リソース、条件リファレンスアクセスコントロール (p. 33) をセットアップし、IAM アイデンティティにアタッチできるアクセス権限ポリシー (アイデンティティベースのポリシー) を作成するときは、以下のリストをリファレンスとして使用できます。一覧には、各 AWS Backup API オペレーション、実行アクセス許可を付与する対象となるアクション、アクセス許可を付与する対象となる AWS リソースを示しています。ポリシーの Actionフィールドでアクションを指定し、ポリシーの Resource フィールドでリソースの値を指定します。
AWS Backup ポリシーで AWS 全体の条件キーを使用して、条件を表現することができます。AWS 全体を対象とするキーの完全なリストについては、『IAM ユーザーガイド』の「利用可能なキー」を参照してください。
バックアップボールトに保存されているリソースにメタデータタグを保存するには、指定したリソースタイプに対して次の権限が必要です。
バックアップにタグを割り当てるために必要な権限
リソースタイプ 必要なアクセス権限
Amazon EFS ファイルシステム elasticfilesystem:DescribeTags
Amazon EBS ボリューム ec2:DescribeTags
Amazon RDS データベース rds:ListTagsForResource
AWS Storage Gateway ボリューム storagegateway:ListTagsForResource
アクセスポリシーアクセス許可ポリシーでは、だれが何にアクセスできるかを定義します。IAM ID にアタッチされているポリシーは、アイデンティティベースのポリシー (IAM ポリシー) と呼ばれます。リソースにアタッチされたポリシーは、リソースベースのポリシーと呼ばれます。AWS Backup では、アイデンティティベースのポリシーとリソースベースのポリシーの両方をサポートしています。
35
AWS Backup 開発者ガイドアクセスコントロール
Note
このセクションでは、AWS Backup のコンテキストでの IAM の使用について説明します。IAMサービスに関する詳細情報は提供しません。IAM の詳細な説明については、IAM ユーザーガイドの「IAM とは」を参照してくださいIAM ポリシー構文の詳細および説明については、IAM ユーザーガイド の「IAM JSON ポリシーリファレンス」を参照してください。
アイデンティティベースのポリシー (IAM ポリシー)
アイデンティティベースのポリシーは、IAM アイデンティティ (ユーザーやロールなど) にアタッチできるポリシーです。たとえば、ユーザーに AWS リソースの表示とバックアップは許可するがバックアップの復元を禁止するポリシーを定義できます。
ユーザー、グループ、ロール、アクセス権限の詳細については、IAM ユーザーガイド の「アイデンティティ (ユーザー、グループ、ロール)」を参照してください。
IAM ポリシーを使用してバックアップへのアクセスを制御する方法については、「管理ポリシー (p. 36)」を参照してください。
リソースベースのポリシー
AWS Backup では、バックアップボールトのリソースベースのアクセスポリシーがサポートされています。これにより、バックアップボールト内の整理された任意のバックアップにどのユーザーがどのようなアクセス許可を持つかを制御できるアクセスポリシーを定義できます。バックアップボールトのリソースベースのアクセスポリシーを使用すると、バックアップへのアクセスを簡単に制御できます。
バックアップボールトのアクセスポリシーは、AWS Backup API を使用するときのユーザーアクセスを制御します。Amazon Elastic Block Store (Amazon EBS) や Amazon Relational Database Service (AmazonRDS) スナップショットなどの一部のタイプのバックアップにも、これらのサービスの API を使用してアクセスできます。バックアップへのアクセスを完全に制御するために、これらの API へのアクセスを制御する個別のアクセスポリシーを IAM で作成できます。
バックアップボールトのアクセスポリシーを作成する方法については、「バックアップボールトと復旧ポイントに対するアクセスポリシーの設定 (p. 21)」を参照してください。
管理ポリシー管理ポリシーは、AWS アカウント内の複数のユーザー、グループ、ロールにアタッチできるスタンドアロンアイデンティティベースのポリシーです。AWS 管理ポリシーまたはカスタマー管理ポリシーを使用して、AWS Backup 内のバックアップへのアクセスを制御できます。
AWS 管理ポリシー
AWS 管理ポリシーは、AWS が作成および管理するスタンドアロンポリシーです。AWS 管理ポリシーは、多くの一般的ユースケースでアクセス許可を付与できるように設計されています。AWS 管理ポリシーでは、ポリシーを自分で記述する場合よりも簡単に、適切なアクセス許可をユーザー、グループ、ロールに割り当てることができます。
AWS 管理ポリシーに定義されているアクセス許可は変更できません。AWS は、AWS 管理ポリシーに定義されているアクセス許可を不定期に更新します。行われた更新は、ポリシーがアタッチされているすべてのプリンシパルエンティティ (ユーザー、グループ、ロール) に影響します。
AWS Backup には、一般的ユースケースに対していくつかの AWS 管理ポリシーが用意されています。これらのポリシーではより簡単に、適切なアクセス許可を定義し、バックアップへのアクセスを制御できます。管理ポリシーには 2 種類あります。1 つのタイプは、AWS Backup へのアクセスを制御するためにユーザーに割り当てられるように設計されています。もう 1 つのタイプは、AWS Backup に渡すロールにアタッチされるように設計されています。これらのポリシーは、お客様に代わって AWS Backup がバックアップオペレーションを実行するために必要になる適切なアクセス許可で事前定義されています。
36
AWS Backup 開発者ガイドアクセスコントロール
以下の表では、AWS Backup が提供するすべての管理ポリシーを示し、それらのポリシーがどのように定義されているかを説明しています。これらの管理ポリシーは、IAM コンソールの [ポリシー] セクションにあります。
ポリシー名 IAM 管理ポリシー名 説明
バックアップ管理者 IAM ポリシー
AWSBackupAdminPolicy バックアップ管理者は、バックアップ計画の作成や編集、バックアップ計画への AWS リソースの割り当て、バックアップの復元など、AWS Backup のオペレーションにフルアクセスできます。バックアップ管理者は、バックアップのコンプライアンスの決定と実施を担当し、組織のビジネスおよび規制関連の要件を満たすバックアップ計画を定義します。バックアップ管理者は、組織の AWS リソースが適切な計画に割り当てられていることも確認します。
バックアップオペレーター IAMポリシー
AWSBackupOperatorPolicy バックアップオペレーターは、担当するリソースが適切にバックアップされていることを確認する責任のあるユーザーです。バックアップオペレーターは、バックアップ管理者が作成したバックアップ計画に AWS リソースを割り当てるためのアクセス許可を持っています。また、AWS リソースのオンデマンドバックアップを作成し、オンデマンドバックアップの保持期間を設定するためのアクセス許可も持っています。バックアップオペレーターは、バックアップ計画を作成または編集したり、スケジュールされたバックアップを作成後に削除したりするためのアクセス許可は持っていません。バックアップオペレーターはバックアップを復元できます。バックアップオペレーター がバックアッププランに割り当てることができるリソースタイプや、バックアップから復元できるリソースタイプを制限できます。これを行うには、特定のリソースタイプに対するアクセス権限を持つ特定のサービスロールのみを AWSBackup に渡します。
バックアップ用のデフォルトのサービスロールポリシー
AWSBackupServiceRolePolicyForBackupサポートされているすべてのリソースタイプのバックアップをお客様に代わって作成するため
37
AWS Backup 開発者ガイドアクセスコントロール
ポリシー名 IAM 管理ポリシー名 説明のアクセス許可を AWS Backupに付与します。
復元用のデフォルトのサービスロールポリシー
AWSBackupServiceRolePolicyForRestoresサポートされているすべてのリソースタイプのバックアップをお客様に代わって復元するためのアクセス許可を AWS Backupに付与します。
カスタマー管理ポリシースタンドアロンポリシーを作成して独自の AWS アカウントで管理できます。これらのポリシーはカスタマー管理ポリシーと呼ばれます。それらのポリシーは AWS アカウントの複数のプリンシパルエンティティにアタッチできます。ポリシーをプリンシパルエンティティにアタッチすると、ポリシーで定義されたアクセス権限がエンティティに付与されます。
カスタマー管理ポリシーを作成する方法の 1 つは、既存の AWS 管理ポリシーをコピーして開始することです。この方法では、最初の段階でポリシーが正しいことがわかっていれば、後はそのポリシーをお客様の環境に合わせてカスタマイズするだけです。
以下のポリシーでは、個々の AWS のサービスのバックアップと復元のアクセス権限を指定します。AWSリソースへのアクセスをさらに制限するために、作成したロールをカスタマイズしてアタッチすることができます。
個々のサービスのバックアップおよび復元ポリシー
サービスバックアップポリシー サービス復元ポリシー
DynamoDB バックアップポリシー
{ "Version": "2012-10-17", "Statement": [ { "Action": [ "dynamodb:DescribeTable", "dynamodb:CreateBackup" ], "Resource": "arn:aws:dynamodb:*:*:table/*", "Effect": "Allow" }, { "Action": [ "dynamodb:DescribeBackup", "dynamodb:DeleteBackup" ], "Resource": "arn:aws:dynamodb:*:*:table/*/backup/*", "Effect": "Allow" } ]}
DynamoDB 復元ポリシー
{ "Version": "2012-10-17", "Statement": [ { "Action": [ "dynamodb:DescribeBackup", "dynamodb:DescribeTable", "dynamodb:RestoreTableFromBackup", "dynamodb:Scan", "dynamodb:Query", "dynamodb:UpdateItem", "dynamodb:PutItem", "dynamodb:GetItem", "dynamodb:DeleteItem", "dynamodb:BatchWriteItem" ], "Resource": "arn:aws:dynamodb:*:*:table/*", "Effect": "Allow" }, { "Action": [ "dynamodb:RestoreTableFromBackup" ], "Resource": "arn:aws:dynamodb:*:*:table/*/backup/*",
38
AWS Backup 開発者ガイドアクセスコントロール
サービスバックアップポリシー サービス復元ポリシー "Effect": "Allow" } ]}
Amazon EBS バックアップポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "ec2:CreateTags", "Resource": "arn:aws:ec2:*::snapshot/*" }, { "Effect": "Allow", "Action": [ "ec2:CreateSnapshot", "ec2:DeleteSnapshot" ], "Resource": [ "arn:aws:ec2:*::snapshot/*", "arn:aws:ec2:*:*:volume/*" ] }, { "Effect": "Allow", "Action": [ "ec2:DescribeVolumes", "ec2:DescribeSnapshots" ], "Resource": "*" }, { "Action": [ "tag:GetResources" ], "Resource": "*", "Effect": "Allow" } ]}
Amazon EBS 復元ポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ec2:CreateVolume", "ec2:DeleteVolume" ], "Resource": [ "arn:aws:ec2:*::snapshot/*", "arn:aws:ec2:*:*:volume/*" ] }, { "Effect": "Allow", "Action": [ "ec2:DescribeSnapshots", "ec2:DescribeVolumes" ], "Resource": "*" } ]}
39
AWS Backup 開発者ガイドアクセスコントロール
サービスバックアップポリシー サービス復元ポリシー
Amazon EFS バックアップポリシー
{ "Version": "2012-10-17", "Statement": [ { "Action": [ "elasticfilesystem:Backup" ], "Resource": "arn:aws:elasticfilesystem:*:*:file-system/*", "Effect": "Allow" }, { "Action": [ "tag:GetResources" ], "Resource": "*", "Effect": "Allow" } ]}
Amazon EFS 復元ポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "elasticfilesystem:Restore", "elasticfilesystem:CreateFilesystem", "elasticfilesystem:DescribeFilesystems", "elasticfilesystem:DeleteFilesystem" ], "Resource": "arn:aws:elasticfilesystem:*:*:file-system/*" } ]}
40
AWS Backup 開発者ガイドアクセスコントロール
サービスバックアップポリシー サービス復元ポリシー
Amazon RDS バックアップポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rds:AddTagsToResource", "rds:ListTagsForResource", "rds:DescribeDBSnapshots", "rds:CreateDBSnapshot", "rds:CopyDBSnapshot", "rds:DescribeDBInstances" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "rds:DeleteDBSnapshot" ], "Resource": [ "arn:aws:rds:*:*:snapshot:awsbackup:*" ] }, { "Action": [ "tag:GetResources" ], "Resource": "*", "Effect": "Allow" } ]}
Amazon RDS 復元ポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rds:DescribeDBInstances", "rds:DescribeDBSnapshots", "rds:ListTagsForResource", "rds:RestoreDBInstanceFromDBSnapshot", "rds:DeleteDBInstance", "rds:AddTagsToResource" ], "Resource": "*" } ]}
41
AWS Backup 開発者ガイドIAM サービスロール
サービスバックアップポリシー サービス復元ポリシー
AWS Storage Gateway バックアップポリシー
"Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "storagegateway:CreateSnapshot" ], "Resource": "arn:aws:storagegateway:*:*:gateway/*/volume/*" }, { "Effect": "Allow", "Action": [ "ec2:CreateTags", "ec2:DeleteSnapshot" ], "Resource": "arn:aws:ec2:*::snapshot/*" }, { "Effect": "Allow", "Action": [ "ec2:DescribeSnapshots" ], "Resource": "*" }, { "Action": [ "tag:GetResources" ], "Resource": "*", "Effect": "Allow" } ]}
AWS Storage Gateway 復元ポリシー
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "storagegateway:DeleteVolume", "storagegateway:DescribeCachediSCSIVolumes", "storagegateway:DescribeStorediSCSIVolumes" ], "Resource": "arn:aws:storagegateway:*:*:gateway/*/volume/*" }, { "Effect": "Allow", "Action": [ "storagegateway:DescribeGatewayInformation", "storagegateway:CreateStorediSCSIVolume", "storagegateway:CreateCachediSCSIVolume" ], "Resource": "arn:aws:storagegateway:*:*:gateway/*" }, { "Effect": "Allow", "Action": [ "storagegateway:ListVolumes" ], "Resource": "arn:aws:storagegateway:*:*:*" } ]}
IAM サービスロールAWS Identity and Access Management (IAM) ロールは、AWS で許可/禁止する操作を決めるアクセス許可ポリシーが関連付けられている AWS アイデンティティであるという点で、ユーザーと似ています。ただし、ユーザーは 1 人の特定の人に一意に関連付けられますが、ロールはそれを必要とする任意の人が引き受けるようになっています。サービスロールは、AWS のサービスがお客様に代わってアクションを実行するために引き受けるロールです。お客様に代わってバックアップオペレーションを実行するサービスとして、AWS Backup には、お客様に代わってバックアップオペレーションを実行するときに、ロールを渡す必要があります。IAM ロールの詳細については、IAM ユーザーガイド の「IAM ロール」を参照してください。
42
AWS Backup 開発者ガイドIAM サービスロール
AWS Backup に渡すロールには、AWS Backup がバックアップの作成、復元、期限切れ指定などのバックアップオペレーションに関連したアクションを実行するためのアクセス許可を付与する IAM ポリシーが必要です。AWS Backup がサポートする AWS のサービスごとに異なるアクセス許可が必要です。ロールには、AWS Backup が信頼されたエンティティとして登録されている必要があります。これにより、AWSBackup はロールを引き受けることができます。
バックアップを復元または作成するときに、ロールを AWS Backup に渡します。AWS リソースをバックアップ計画に割り当てるときにも、ロールを指定します。これは、リソースを割り当てたバックアップ計画に従って、お客様に代わってバックアップを作成および期限切れにするときに、AWS Backup が引き受けるロールです。
AWS ロールを使用したバックアップに対するアクセスコントロールロールを使用してバックアップへのアクセスを制御するには、適用範囲を絞り込んだロールを定義し、そのロールを AWS Backup に渡すことのできるユーザーを指定します。たとえば、Amazon RelationalDatabase Service (Amazon RDS) データベースをバックアップするためのアクセス許可のみを付与するロールを作成し、そのロールを AWS Backup に渡すためのアクセス許可を Amazon RDS データベース所有者にのみ付与できます。AWS Backup には、サポートされている各サービス用に事前定義されたいくつかの管理ポリシーが用意されています。これらの管理ポリシーは、作成したロールにアタッチできます。これにより、AWS Backup に必要な適切なアクセス権限を持つサービス固有のロールを簡単に作成できます。
AWS Backup の AWS 管理ポリシーの詳細については、「管理ポリシー (p. 36)」を参照してください。
AWS Backup のデフォルトのサービスロール初めて AWS Backup を使用するときは、AWS Backup でデフォルトのサービスロールが作成されるように選択できます。このロールは、AWS Backup がサポートしているすべての AWS のサービスに対してバックアップオペレーションを実行するためのアクセス許可を持っています。バックアップするすべてのリソースタイプに同じロールを使用しても問題ない場合は、デフォルトのロールを使用してください。セキュリティ上の理由からリソースタイプごとに別々のロールを使用する場合は、デフォルトのロールを使用するのではなく、独自のロールを作成して AWS Backup に渡すこともできます。
Note
初めて AWS Backup を使用する場合は、ロールを作成し、ロールを登録して、ロールにアクセス許可を付与する必要があります。ロールの作成後は、ロールの登録と引き渡しのためのアクセス許可のみが必要です。
AWS Backup によって作成可能なデフォルトのロールは 2 つあります。1 つはバックアップの作成用、もう 1 つはバックアップの復元用です。
バックアップ用のデフォルトの AWS Backup サービスロール
このロールには、バックアップされるリソースを定義するためのアクセス許可、バックアップを作成、削除、または定義する機能、バックアップにタグを追加する機能を AWS Backup に付与する IAM ポリシーが含まれています。この IAM ポリシーには、AWS Backup がサポートしているすべてのリソースタイプに必要なアクセス許可が含まれています。
復元用のデフォルトの AWS Backup サービスロール
このロールには、バックアップから作成される新しいリソースを作成、削除、または定義するためのアクセス許可を AWS Backup に付与する IAM ポリシーが含まれています。また、新しく作成されたリソースにタグを付けるためのアクセス許可も含まれています。この IAM ポリシーには、AWS Backup がサポートしているすべてのリソースタイプに必要なアクセス許可が含まれています。
43
AWS Backup 開発者ガイドロギングとモニタリング
AWS Backup でのログ記録とモニタリングモニタリングは、AWS Backup およびお客様の AWS ソリューションの信頼性、可用性、パフォーマンスを維持する上で重要な部分です。マルチポイント障害が発生した場合は、その障害をより簡単にデバッグできるように、AWS ソリューションのすべての部分からモニタリングデータを収集する必要があります。AWS には、AWS Backup リソースをモニタリングし、潜在的なインシデントに対応するための複数のツールが用意されています。
AWS CloudTrail ログ
CloudTrail は、AWS Backup のユーザー、ロール、AWS のサービスによって実行されたアクションのレコードを提供します。CloudTrail によって収集された情報を使用して、AWS Backup に対して行われたリクエスト、リクエスト元の IP アドレス、リクエスト者、リクエスト日時などの詳細を確認できます。詳細については、「AWS CloudTrail を使用した AWS Backup API コールのログ作成 (p. 52)」を参照してください。
AWS Trusted Advisor
Trusted Advisor は、AWS の数十万のお客様にサービスを提供することにより得られた、運用実績から学んだベストプラクティスを活用しています。Trusted Advisor はお客様の AWS 環境を検査し、システムの可用性とパフォーマンスを向上させたりセキュリティギャップを埋めたりする機会がある場合には、推奨事項を作成します。すべての AWS のお客様は、Trusted Advisor の 5 つのチェックにアクセスできます。ビジネスまたはエンタープライズサポートプランをご利用のお客様は、すべてのTrusted Advisor チェックを表示できます。詳細については、「AWS Trusted Advisor」を参照してください。
AWS Backup のコンプライアンス検証サードパーティーの監査者は、SOC、PCI、FedRAMP、HIPAA など複数の AWS コンプライアンスプログラムの一環として AWS Backup のセキュリティとコンプライアンスを評価します。
特定のコンプライアンスプログラムの範囲内の AWS サービスのリストについては、「コンプライアンスプログラムによる AWS 対象範囲内のサービス」を参照してください。一般的な情報については、「AWSコンプライアンスプログラム」を参照してください。
サードパーティーの監査レポートをダウンロードするには、AWS Artifact を使用します。詳細については、AWS Artifact ユーザーガイドの「AWS Artifact のレポートのダウンロード」を参照してください。
AWS Backup を使用する際のお客様のコンプライアンス責任は、お客様のデータの機密性や組織のコンプライアンス目的、適用可能な法律および規制によって決定されます。AWS Backup の使用がHIPAA、PCI、FedRAMP などの規格に準拠していることを前提としている場合、AWS は以下を支援するリソースを提供します。
• セキュリティおよびコンプライアンスのクイックスタートガイド – これらのデプロイメントガイドでは、アーキテクチャ上の考慮事項について説明し、セキュリティとコンプライアンスに重点を置いたベースライン環境を AWS にデプロイするための手順を説明します。
• HIPAA のセキュリティとコンプライアンスに関するホワイトペーパーを作成する – このホワイトペーパーでは、企業が AWS を使用して HIPAA 準拠のアプリケーションを作成する方法について説明します。
• AWS コンプライアンスのリソース – このワークブックとガイドのコレクションは、お客様の業界や場所に適用される場合があります。
• AWS Config – この AWS サービスでは、自社プラクティス、業界ガイドライン、および規制に対するリソースの設定の準拠状態を評価します。
• AWS Security Hub – この AWS サービスでは、AWS 内のセキュリティ状態を包括的に表示しており、セキュリティ業界の標準およびベストプラクティスへの準拠を確認するのに役立ちます。
44
AWS Backup 開発者ガイド弾力
AWS Backup の耐障害性AWS のグローバルインフラストラクチャは AWS リージョンとアベイラビリティーゾーンを中心として構築されます。AWS リージョンには、低レイテンシー、高いスループット、そして高度の冗長ネットワークで接続されている複数の物理的に独立・隔離されたアベイラビリティーゾーンがあります。アベイラビリティーゾーンでは、アベイラビリティーゾーン間で中断することなく自動的にフェイルオーバーするアプリケーションとデータベースを設計および運用することができます。アベイラビリティーゾーンは、従来の単一または複数のデータセンターインフラストラクチャよりも可用性、耐障害性、および拡張性が優れています。
AWS リージョンとアベイラビリティーゾーンの詳細については、「AWS グローバルインフラストラクチャ」を参照してください。
AWS Backup のインフラストラクチャセキュリティ
マネージド型サービスとして、AWS Backup は、ホワイトペーパー「Amazon Web Services: AWS セキュリティプロセスの概要」に記載されているAWS グローバルネットワークセキュリティの手順で保護されています。
AWS が公開した API コールを使用して、ネットワーク経由で AWS Backup にアクセスします。クライアントで Transport Layer Security (TLS) 1.0 以降がサポートされている必要があります。TLS 1.2 以降が推奨されています。また、Ephemeral Diffie-Hellman (DHE) や Elliptic Curve Ephemeral Diffie-Hellman(ECDHE) などの Perfect Forward Secrecy (PFS) を使用した暗号スイートもサポートしている必要があります。これらのモードは、Java 7 以降など、最近のほとんどのシステムでサポートされています。
また、リクエストは、アクセスキー ID と、IAM プリンシパルに関連付けられているシークレットのアクセスキーを使用して署名する必要があります。または、AWS Security Token Service (AWS STS) を使用して、一時的なセキュリティ認証情報を生成し、リクエストに署名することもできます。
45
AWS Backup 開発者ガイド
制限以下で、AWS Backup を使用する際の制限について学びます。
リソース 制限
アカウントあたりのバックアップボールト数 100
アカウントあたりのバックアッププラン数 100
バックアッププランあたりのバージョン数 2,000
リソースあたりの同時バックアップジョブ数 1
バックアッププランあたりのリソース割り当て数 100*
保存されたリソースあたりのメタデータタグの数 50
バックアップボールトあたりの復旧ポイント数 1,000,000
* この制限は、バックアップ計画に関連付けられたリソース割り当てドキュメントの数に適用されます。割り当てドキュメントで参照されるリソースの数に制限はありません。
46
AWS Backup 開発者ガイドAWS Backup 通知 API
Amazon SNS を使用しての AWSBackup イベントの追跡
AWS Backup は Amazon Simple Notification Service (Amazon SNS) で配信される強固な通知機能の利点を活用できるように設計されています。Amazon SNS コンソールから AWS Backup イベントの通知を送信するように Amazon SNS を設定します。詳細については、Amazon Simple Notification Service 開発者ガイド の「Amazon SNS の開始方法」を参照してください。
トピック• AWS Backup 通知 API (p. 47)• 完了したイベント (p. 47)• AWS Backup 通知コマンドの例 (p. 49)• サービスプリンシパルとしての AWS Backup の指定 (p. 50)
AWS Backup 通知 APIAmazon SNS コンソールまたは AWS Command Line Interface (AWS CLI) を使用してトピックを作成したら、次の AWS Backup API オペレーションを使用してバックアップ通知を管理できます。
• DeleteBackupVaultNotifications (p. 81)— 指定されたバックアップボールトのイベント通知を削除します。
• GetBackupVaultNotifications (p. 121)— 指定されたバックアップボールトのすべてのイベント通知を一覧表示します。
• PutBackupVaultNotifications (p. 158) — 指定されたトピックとイベントの通知をオンにします。
次のイベントがサポートされています。
バックアップジョブ
• BACKUP_JOB_STARTED
• BACKUP_JOB_COMPLETED
復元ジョブ
• RESTORE_JOB_STARTED
• RESTORE_JOB_COMPLETED
復旧ポイント
• RECOVERY_POINT_MODIFIED
完了したイベントCompleted 通知には、完了の特定のタイプを示す STATE 属性が含まれます。
47
AWS Backup 開発者ガイド例 : 完了したイベント
例 : 完了したイベント
{ "Type" : "Notification", "MessageId" : "12345678-abcd-123a-def0-abcd1a234567", "TopicArn" : "arn:aws:sns:us-west-1:123456789012:backup-2sqs-sns-topic", "Subject" : "Notification from AWS Backup", "Message" : "An AWS Backup job was completed successfully. Recovery point ARN: arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012d. Resource ARN : arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012e. BackupJob ID : 1b2345b2-f22c-4dab-5eb6-bbc7890ed123", "Timestamp" : "2019-08-02T18:46:02.788Z", "MessageAttributes" : { "EventType" : {"Type":"String","Value":"BACKUP_JOB"}, "State" : {"Type":"String","Value":"COMPLETED"}, "AccountId" : {"Type":"String","Value":"123456789012"}, "Id" : {"Type":"String","Value":"1b2345b2-f22c-4dab-5eb6-bbc7890ed123"}, "StartTime" : {"Type":"String","Value":"2019-09-02T13:48:52.226Z"} }}
{ "Type" : "Notification", "MessageId" : "12345678-abcd-123a-def0-abcd1a234567", "TopicArn" : "arn:aws:sns:us-west-1:123456789012:backup-2sqs-sns-topic", "Subject" : "Notification from AWS Backup", "Message" : "An AWS Backup job failed. Resource ARN : arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012e. BackupJob ID : 1b2345b2-f22c-4dab-5eb6-bbc7890ed123", "Timestamp" : "2019-08-02T18:46:02.788Z", "MessageAttributes" : { "EventType" : {"Type":"String","Value":"BACKUP_JOB"}, "State" : {"Type":"String","Value":"FAILED"}, "AccountId" : {"Type":"String","Value":"123456789012"}, "Id" : {"Type":"String","Value":"1b2345b2-f22c-4dab-5eb6-bbc7890ed123"}, "StartTime" : {"Type":"String","Value":"2019-09-02T13:48:52.226Z"} }}
{ "Type" : "Notification", "MessageId" : "12345678-abcd-123a-def0-abcd1a234567", "TopicArn" : "arn:aws:sns:us-west-1:123456789012:backup-2sqs-sns-topic", "Subject" : "Notification from AWS Backup", "Message" : "An AWS Backup job failed to complete in time. Resource ARN : arn:aws:ec2:us-west-1:123456789012:volume/vol-012f345df6789012e. BackupJob ID : 1b2345b2-f22c-4dab-5eb6-bbc7890ed123", "Timestamp" : "2019-08-02T18:46:02.788Z", "MessageAttributes" : { "EventType" : {"Type":"String","Value":"BACKUP_JOB"}, "State" : {"Type":"String","Value":"EXPIRED"}, "AccountId" : {"Type":"String","Value":"123456789012"}, "Id" : {"Type":"String","Value":"1b2345b2-f22c-4dab-5eb6-bbc7890ed123"}, "StartTime" : {"Type":"String","Value":"2019-09-02T13:48:52.226Z"} }}
48
AWS Backup 開発者ガイドAWS Backup 通知コマンドの例
AWS Backup 通知コマンドの例AWS CLI コマンドを使用して、AWS Backup イベントの Amazon SNS 通知をサブスクライブ、一覧表示、削除できます。
バックアップボールトのプット通知の例次のコマンドは、復元ジョブが開始または完了したとき、または復旧ポイントが変更されたときに通知する、指定されたバックアップボールトの Amazon SNS トピックをサブスクライブします。
aws backup --endpoint-url https://backup.region.amazonaws.com put-backup-vault-notifications --backup-vault-name --sns-topic-arn arn:aws:sns:region:account-id:myBackupTopic --backup-vault-events RESTORE_JOB_STARTED RESTORE_JOB_COMPLETED RECOVERY_POINT_MODIFIED
バックアップボールト取得通知の例次のコマンドは、指定したバックアップボールトの Amazon SNS トピックに現在サブスクライブされているすべてのイベントを一覧表示します。
aws backup --endpoint-url https://backup.region.amazonaws.com get-backup-vault-notifications --backup-vault-name myVault
次に出力例を示します。
{ "SNSTopicArn": "arn:aws:sns:region:account-id:myBackupTopic", "BackupVaultEvents": [ "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RECOVERY_POINT_MODIFIED" ], "BackupVaultName": "myVault", "BackupVaultArn": "arn:aws:backup:region:account-id:backup-vault:myVault"}
バックアップボールトの削除通知の例次のコマンドは、指定されたバックアップボールトの Amazon SNS トピックからサブスクライブを解除します。
aws backup --endpoint-url https://backup.region.amazonaws.com delete-backup-vault-notifications --backup-vault-name myVault
49
AWS Backup 開発者ガイドサービスプリンシパルとしての AWS Backup の指定
サービスプリンシパルとしての AWS Backup の指定
Note
AWS Backup がユーザーに代わって SNS トピックを発行できるようにするには、サービスプリンシパルとして AWS Backup を指定する必要があります。
AWS Backup イベントの追跡に使用する Amazon SNS トピックのアクセスポリシーに次の JSON を含めます。トピックのリソースの Amazon リソースネーム (ARN) を指定する必要があります。
{ "Sid": "My-statement-id", "Effect": "Allow", "Principal": { "Service": "backup.amazonaws.com" }, "Action": "SNS:Publish", "Resource": "arn:aws:sns:region:account-id:myTopic"}
次のサンプル JSON は、サービスプリンシパルとして AWS Backup を含む基本的な Amazon SNS アクセスポリシーの例です。独自の AWS アカウント ID とトピックのリソース ARN を指定する必要があります。
{ "Version": "2008-10-17", "Id": "__default_policy_ID", "Statement": [ { "Sid": "__default_statement_ID", "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": [ "SNS:Publish", "SNS:RemovePermission", "SNS:SetTopicAttributes", "SNS:DeleteTopic", "SNS:ListSubscriptionsByTopic", "SNS:GetTopicAttributes", "SNS:Receive", "SNS:AddPermission", "SNS:Subscribe" ], "Resource": "arn:aws:sns:region:account-id:myTopic", "Condition": { "STRINGEQUALS": { "AWS:SourceOwner": "account-id" } } }, { "Sid": "__console_pub_0", "Effect": "Allow", "Principal": {
50
AWS Backup 開発者ガイドサービスプリンシパルとしての AWS Backup の指定
"Service": "backup.amazonaws.com" }, "Action": "SNS:Publish", "Resource": "arn:aws:sns:region:account-id:myTopic" } ]}
Amazon SNS アクセスポリシーでサービスプリンシパルを指定する方法の詳細については、AmazonSimple Notification Service 開発者ガイド の「すべての AWS リソースのトピックへの発行の許可」を参照してください。
Note
トピックが暗号化されている場合は、ポリシーに追加のアクセス権限を追加して、AWS Backupがそのトピックに公開することを許可する必要があります。暗号化されたトピックへのサービスの発行の有効化の詳細については、Amazon Simple Notification Service 開発者ガイド の「AWSサービスからのイベントソースと暗号化されたトピック間の互換性を有効にする」を参照してください。
51
AWS Backup 開発者ガイドCloudTrail 内の AWS Backup 情報
AWS CloudTrail を使用した AWSBackup API コールのログ作成
AWS Backup は、AWS Backup のユーザーやロール、または AWS のサービスによって実行されたアクションを記録するサービスである AWS CloudTrail と統合されています。CloudTrail は、AWS Backup のすべての API コールをイベントとしてキャプチャします。キャプチャされた呼び出しには、AWS Backupコンソールの呼び出しと、AWS Backup API オペレーションへのコード呼び出しが含まれます。証跡を作成する場合は、AWS Backup のイベントなど、Amazon S3 バケットへの CloudTrail イベントの継続的な配信を有効にすることができます。証跡を設定しない場合でも、CloudTrail コンソールの [Event history(イベント履歴)] で最新のイベントを表示できます。CloudTrail によって収集された情報を使用して、リクエストの作成元の IP アドレス、リクエストの実行者、リクエストの実行日時などの詳細を調べて、AWSBackup に対してどのようなリクエストが行われたかを判断できます。
CloudTrail の詳細については、「AWS CloudTrail User Guide」を参照してください。
CloudTrail 内の AWS Backup 情報CloudTrail は、アカウント作成時に AWS アカウントで有効になります。AWS Backup でアクティビティが発生すると、そのアクティビティは [イベント履歴] の AWS の他のサービスのイベントとともにCloudTrail イベントに記録されます。最近のイベントは、AWS アカウントで表示、検索、ダウンロードできます。詳細については、「CloudTrail イベント履歴でのイベントの表示」を参照してください。
AWS Backup のイベントなど、AWS アカウントのイベントの継続的な記録については、証跡を作成します。証跡により、CloudTrail はログファイルを Amazon S3 バケットに配信できます。デフォルトでは、コンソールで作成した証跡がすべての AWS リージョンに適用されます。証跡では、AWS パーティションのすべてのリージョンからのイベントがログに記録され、指定した Amazon S3 バケットにログファイルが配信されます。さらに、より詳細な分析と AWS ログで収集されたデータに基づいた行動のためにその他の CloudTrail サービスを設定できます。詳細については、以下を参照してください。
• 証跡を作成するための概要• CloudTrail でサポートされるサービスと統合• CloudTrail の Amazon SNS 通知の設定• 「複数のリージョンから CloudTrail ログファイルを受け取る」と「複数のアカウントから CloudTrail ロ
グファイルを受け取る」
AWS Backup アクションはすべて CloudTrail によって記録されます。これらのアクションは AWS BackupAPI Actions (p. 61)で説明されています。
各イベントまたはログエントリには、リクエストの生成者に関する情報が含まれます。この ID 情報は以下のことを確認するのに役立ちます。
• リクエストが、ルートまたは AWS Identity and Access Management (IAM) ユーザー認証情報のどちらを使用して送信されたかどうか。
• リクエストが、ロールとフェデレーティッドユーザーのどちらの一時的なセキュリティ認証情報を使用して送信されたか.
• リクエストが、別の AWS サービスによって送信されたかどうか。
詳細については、「CloudTrail userIdentity 要素」を参照してください。
52
AWS Backup 開発者ガイドAWS Backup ログファイルエントリの概要
AWS Backup ログファイルエントリの概要証跡は、指定した Amazon S3 バケットにイベントをログファイルとして配信できる設定です。CloudTrailログファイルには、1 つ以上のログエントリが含まれます。イベントは任意の送信元からの単一のリクエストを表し、リクエストされたアクション、アクションの日時、リクエストのパラメータなどに関する情報が含まれます。CloudTrail ログファイルは、パブリック API コールの順序付けられたスタックトレースではないため、特定の順序では表示されません。
以下の例は、StartBackupJob、StartRestoreJob、DeleteRecoveryPoint アクション、およびBackupJobCompleted アクションの CloudTrail ログエントリを示しています。
{ "eventVersion": "1.05", "userIdentity": { "type": "Root", "principalId": "123456789012", "arn": "arn:aws:iam::123456789012:root", "accountId": "123456789012", "accessKeyId": AKIAIOSFODNN7EXAMPLE, "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2019-01-10T12:24:50Z" } } }, "eventTime": "2019-01-10T13:45:24Z", "eventSource": "backup.amazonaws.com", "eventName": "StartBackupJob", "awsRegion": "us-east-1", "sourceIPAddress": "12.34.567.89", "userAgent": "aws-internal/3 aws-sdk-java/1.11.465 Linux/4.9.124-0.1.ac.198.73.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.192-b12 java/1.8.0_192", "requestParameters": { "backupVaultName": "Default", "resourceArn": "arn:aws:ec2:us-east-1:123456789012:volume/vol-00a422a05b9c6asd3", "iamRoleArn": "arn:aws:iam::123456789012:role/AWSBackup", "startWindowMinutes": 60 }, "responseElements": { "backupJobId": "8a3c2a87-b23e-4d56-b045-fa9e88ede4e6", "creationDate": "Jan 10, 2019 1:45:24 PM" }, "requestID": "98cf4d59-8c76-49f7-9201-790743931234", "eventID": "fe8146a5-7812-4a95-90ad-074498be1234", "eventType": "AwsApiCall", "recipientAccountId": "123456789012"},{ "eventVersion": "1.05", "userIdentity": { "type": "Root", "principalId": "123456789012", "arn": "arn:aws:iam::123456789012:root", "accountId": "123456789012", "accessKeyId": "ASIAQLTPYK3BWHVZP45U", "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2019-01-10T12:24:50Z"
53
AWS Backup 開発者ガイドAWS Backup ログファイルエントリの概要
} } }, "eventTime": "2019-01-10T13:49:50Z", "eventSource": "backup.amazonaws.com", "eventName": "StartRestoreJob", "awsRegion": "us-east-1", "sourceIPAddress": "12.34.567.89", "userAgent": "aws-internal/3 aws-sdk-java/1.11.465 Linux/4.9.124-0.1.ac.198.73.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.192-b12 java/1.8.0_192", "requestParameters": { "recoveryPointArn": "arn:aws:ec2:us-east-1::snapshot/snap-00a129455bdbc9d99", "metadata": { "volumeType": "gp2", "availabilityZone": "us-east-1b", "volumeSize": "100" }, "iamRoleArn": "arn:aws:iam::123456789012:role/AWSBackup", "idempotencyToken": "a9c8b4fb-d369-4a58-944b-942e442a8fe3", "resourceType": "EBS" }, "responseElements": { "restoreJobId": "9808E090-8C76-CCB8-4CEA-407CF6AC4C43" }, "requestID": "783ddddc-6d7e-4539-8fab-376aa9668543", "eventID": "ff35ddea-7577-4aec-a132-964b7e9dd423", "eventType": "AwsApiCall", "recipientAccountId": "123456789012"},{ "eventVersion": "1.05", "userIdentity": { "type": "Root", "principalId": "123456789012", "arn": "arn:aws:iam::123456789012:root", "accountId": "123456789012", "accessKeyId": "ASIAQLTPYK3BWHVZP45U", "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2019-01-10T12:24:50Z" } } }, "eventTime": "2019-01-10T14:52:42Z", "eventSource": "backup.amazonaws.com", "eventName": "DeleteRecoveryPoint", "awsRegion": "us-east-1", "sourceIPAddress": "12.34.567.89", "userAgent": "aws-internal/3 aws-sdk-java/1.11.465 Linux/4.9.124-0.1.ac.198.73.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.192-b12 java/1.8.0_192", "requestParameters": { "backupVaultName": "Default", "recoveryPointArn": "arn:aws:ec2:us-east-1::snapshot/snap-05f426fd9daab3433" }, "responseElements": null, "requestID": "f1f1b33a-48da-436c-9a8f-7574f1ab5fd7", "eventID": "2dd70080-5aba-4a79-9a0f-92647c9f0846", "eventType": "AwsApiCall", "recipientAccountId": "123456789012"},{
54
AWS Backup 開発者ガイドAWS Backup ログファイルエントリの概要
"eventVersion": "1.05", "userIdentity": { "accountId": "123456789012", "invokedBy": "backup.amazonaws.com" }, "eventTime": "2019-01-10T08:24:39Z", "eventSource": "backup.amazonaws.com", "eventName": "BackupJobCompleted", "awsRegion": "us-east-1", "sourceIPAddress": "backup.amazonaws.com", "userAgent": "backup.amazonaws.com", "requestParameters": null, "responseElements": null, "eventID": "2e7e4fcf-0c52-467f-9fd0-f61c2fcf7d17", "eventType": "AwsServiceEvent", "recipientAccountId": "123456789012", "serviceEventDetails": { "completionDate": { "seconds": 1547108091, "nanos": 906000000 }, "state": "COMPLETED", "percentDone": 100, "backupJobId": "8A8E738B-A8C5-E058-8224-90FA323A3C0E", "backupVaultName": "BackupVault", "backupVaultArn": "arn:aws:backup:us-east-1:123456789012:backup-vault:BackupVault", "recoveryPointArn": "arn:aws:ec2:us-east-1::snapshot/snap-07ce8c3141d361233", "resourceArn": "arn:aws:ec2:us-east-1:123456789012:volume/vol-06692095a6a421233", "creationDate": { "seconds": 1547101638, "nanos": 272000000 }, "backupSizeInBytes": 8589934592, "iamRoleArn": "arn:aws:iam::123456789012:role/AWSBackup", "resourceType": "EBS" }}
55
AWS Backup 開発者ガイドAWS Backup と AWS CloudFormation の統合
AWS Backup での AWSCloudFormation テンプレートの使用
次の情報では、AWS CloudFormation テンプレートを使用して、バックアップ計画、バックアップボールト、リソース選択に関連するタスクを簡素化および自動化する方法について説明します。
AWS Backup と AWS CloudFormation の統合AWS CloudFormation では、作成したテンプレートを使用して、安全で反復可能な方法で AWS リソースをプロビジョニングおよび管理できます。AWS CloudFormation テンプレートを使用して、バックアップ計画、バックアップリソースの選択、バックアップボールトを管理できます。AWS CloudFormation の使用の詳細については、AWS CloudFormation ユーザーガイド の「AWS CloudFormation のしくみ」を参照してください。
AWS CloudFormation スタックを作成する前に、次の点を考慮する必要があります。
• バックアップ計画とバックアップボールト用に個別のテンプレートを作成することをお勧めします。バックアップボールトは空の場合にのみ削除できるため、バックアップボールトを含むスタックに復旧ポイントが含まれている場合は削除できません。
• スタックを作成する前に、利用可能なサービスロールがあることを確認してください。AWS Backup デフォルトのサービスロールは、リソースをバックアップ計画に初めて割り当てるときに作成されます。これをまだ行っていない場合、デフォルトのサービスロールは使用できません。作成するカスタムロールを指定することもできます。ロールの詳細については、「IAM サービスロール (p. 42)」を参照してください。
次に、バックアップ計画を作成するサンプルテンプレートを示します。
Description: "Backup Plan template to back up all resources tagged with backup=daily daily at 5am UTC."Resources: KMSKey: Type: AWS::KMS::Key Properties: Description: "Encryption key for daily" EnableKeyRotation: True Enabled: True KeyPolicy: Version: "2012-10-17" Statement: - Effect: Allow Principal: "AWS": { "Fn::Sub": "arn:${AWS::Partition}:iam::${AWS::AccountId}:root" } Action: - kms:* Resource: "*" BackupVaultWithDailyBackups: Type: "AWS::Backup::BackupVault" Properties:
56
AWS Backup 開発者ガイドAWS Backup と AWS CloudFormation の統合
BackupVaultName: "BackupVaultWithDailyBackups" EncryptionKeyArn: !GetAtt KMSKey.Arn
BackupPlanWithDailyBackups: Type: "AWS::Backup::BackupPlan" Properties: BackupPlan: BackupPlanName: "BackupPlanWithDailyBackups" BackupPlanRule: - RuleName: "RuleForDailyBackups" TargetBackupVault: !Ref BackupVaultWithDailyBackups ScheduleExpression: "cron(0 5 ? * * *)" DependsOn: BackupVaultWithDailyBackups
DDBTableWithDailyBackupTag: Type: "AWS::DynamoDB::Table" Properties: TableName: "TestTable" AttributeDefinitions: - AttributeName: "Album" AttributeType: "S" KeySchema: - AttributeName: "Album" KeyType: "HASH" ProvisionedThroughput: ReadCapacityUnits: "5" WriteCapacityUnits: "5" Tags: - Key: "backup" Value: "daily" BackupRole: Type: "AWS::IAM::Role" Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Principal: Service: - "backup.amazonaws.com" Action: - "sts:AssumeRole" ManagedPolicyArns: - "arn:aws:iam::aws:policy/service-role/service role"
TagBasedBackupSelection: Type: "AWS::Backup::BackupSelection" Properties: BackupSelection: SelectionName: "TagBasedBackupSelection" IamRoleArn: !GetAtt BackupRole.Arn ListOfTags: - ConditionType: "STRINGEQUALS" ConditionKey: "backup" ConditionValue: "daily" BackupPlanId: !Ref BackupPlanWithDailyBackups DependsOn: BackupPlanWithDailyBackups
57
AWS Backup 開発者ガイドAWS Backup と AWS CloudFormation の統合
デフォルトのサービスロールを使用している場合は、スススススススをAWSBackupServiceRolePolicyForBackup に置き換えます。
AWS Backup での AWS CloudFormation の使用については、AWS CloudFormation ユーザーガイド の「AWS Backup リソースタイプリファレンス」を参照してください。
AWS CloudFormation を使用する場合の AWS サービスリソースへのアクセスを制御する方法については、AWS CloudFormation ユーザーガイド の「AWS Identity and Access Management を使用したアクセスの制御」を参照してください。
58
AWS Backup 開発者ガイド一般的な問題のトラブルシューティング
AWS Backup のトラブルシューティング
AWS Backup を使用すると、バックアップ計画、リソース、バックアップボールトを操作するときに問題が発生することがあります。以降のセクションは、発生する可能性のある一般的な問題のトラブルシューティングに役立ちます。
AWS Backup に関する一般的な質問については、「AWS Backup のよくある質問」を参照してください。また、AWS Backup フォーラムで回答を検索したり、質問を投稿することもできます。
トピック• 一般的な問題のトラブルシューティング (p. 59)• リソース作成のトラブルシューティング (p. 59)• リソースの削除のトラブルシューティング (p. 60)
一般的な問題のトラブルシューティングリソースをバックアップおよび復元するときは、AWS Backup を使用するアクセス権限だけでなく、保護するリソースにアクセスする権限も必要です。AWS Backup で AWS Identity and Access Management(IAM) を使用したアクセス制御の詳細については、「アクセスコントロール (p. 33)」を参照してください。
特定のリソースタイプのバックアップと復元で問題が発生した場合は、そのリソースのトラブルシューティングのトピックを確認すると便利です。他の AWS のサービスのトラブルシューティングの詳細については、以下を参照してください。
• Amazon Elastic File System ユーザーガイド での Amazon EFS と AWS Backup の使用• Amazon DynamoDB 開発者ガイド での DynamoDB のオンデマンドバックアップおよび復元• Linux インスタンス用 Amazon EC2 ユーザーガイド での Amazon EBS スナップショット• Amazon RDS ユーザーガイド での Amazon RDS DB インスタンスのバックアップと復元• AWS Storage Gateway ユーザーガイドの「ボリュームのバックアップ」
AWS Backup がリソースの作成または削除に失敗した場合は、AWS CloudTrail を使用してエラーメッセージやログを表示することで、問題の詳細を確認できます。AWS Backup で CloudTrail を使用する方法については、「AWS CloudTrail を使用した AWS Backup API コールのログ作成 (p. 52)」を参照してください。
リソース作成のトラブルシューティング次の情報は、バックアップの作成の問題をトラブルシューティングするのに役立ちます。
• DynamoDB テーブルのバックアップの作成は、テーブルの作成中に失敗します。通常、DynamoDBテーブルの作成には数分かかります。
• ファイルシステムが非常に大きい場合、Amazon EFS ファイルシステムのバックアップには最大 7 日かかることがあります。Amazon EFS ファイルシステムのキューに入れることができる同時バックアップ
59
AWS Backup 開発者ガイドリソースの削除のトラブルシューティング
は、一度に 1 つのみです。前のバックアップがまだ進行中の間に後続のバックアップがキューに入れられると、バックアップウィンドウが期限切れになることがあり、バックアップは作成されません。
• Amazon EBS には、アカウントあたりの AWS リージョンあたり 100,000 のバックアップというソフト制限があり、この制限に達すると、追加のバックアップは失敗します。この制限に達した場合は、余分なバックアップを削除するか、制限の引き上げをリクエストできます。制限引き上げのリクエストの詳細については、「AWS サービスの制限」を参照してください。
• Amazon RDS バックアップを作成するときは、次の点を考慮してください。• Amazon RDS には、アカウントあたりの AWS リージョンあたり 100 のバックアップというソフト制
限があり、この制限に達すると、追加のバックアップは失敗します。この制限に達した場合は、余分なバックアップを削除するか、制限の引き上げをリクエストできます。制限引き上げのリクエストの詳細については、「AWS サービスの制限」を参照してください。
• バックアップ計画またはオンデマンドバックアップを作成してバックアップを開始した場合、ユーザーが設定できる 30 分単位のバックアップウィンドウ内にバックアップがスケジュールされていると、バックアップは失敗します。自動 Amazon RDS バックアップの詳細については、Amazon RDSユーザーガイドの「バックアップを使用する」を参照してください。
• Amazon RDS の連続バックアップは、少なくとも 6 時間間隔でスケジュールする必要があります。• メンテナンス期間中に開始されたバックアップは失敗します。Amazon RDS メンテナンスウィンドウ
の詳細については、Amazon RDSユーザーガイドの「DB インスタンスのメンテナンス」を参照してください。
リソースの削除のトラブルシューティングAWS Backup によって作成された復旧ポイントは、保護されたリソースのコンソールウィンドウで削除できません。AWS Backup コンソールで削除するには、保存されているボールトで削除し、[Delete (削除)]を選択します。
復旧ポイントまたはバックアップボールトを削除するには、適切な権限が必要です。AWS Backup で IAMを使用するアクセス制御の詳細については、「アクセスコントロール (p. 33)」を参照してください。
60
AWS Backup 開発者ガイドActions
AWS Backup APIActions
The following actions are supported:
• CreateBackupPlan (p. 63)• CreateBackupSelection (p. 66)• CreateBackupVault (p. 69)• DeleteBackupPlan (p. 72)• DeleteBackupSelection (p. 75)• DeleteBackupVault (p. 77)• DeleteBackupVaultAccessPolicy (p. 79)• DeleteBackupVaultNotifications (p. 81)• DeleteRecoveryPoint (p. 83)• DescribeBackupJob (p. 85)• DescribeBackupVault (p. 89)• DescribeCopyJob (p. 92)• DescribeProtectedResource (p. 94)• DescribeRecoveryPoint (p. 96)• DescribeRegionSettings (p. 101)• DescribeRestoreJob (p. 103)• ExportBackupPlanTemplate (p. 106)• GetBackupPlan (p. 108)• GetBackupPlanFromJSON (p. 111)• GetBackupPlanFromTemplate (p. 114)• GetBackupSelection (p. 116)• GetBackupVaultAccessPolicy (p. 119)• GetBackupVaultNotifications (p. 121)• GetRecoveryPointRestoreMetadata (p. 124)• GetSupportedResourceTypes (p. 126)• ListBackupJobs (p. 128)• ListBackupPlans (p. 131)• ListBackupPlanTemplates (p. 133)• ListBackupPlanVersions (p. 135)• ListBackupSelections (p. 137)• ListBackupVaults (p. 139)• ListCopyJobs (p. 141)• ListProtectedResources (p. 144)• ListRecoveryPointsByBackupVault (p. 146)• ListRecoveryPointsByResource (p. 149)• ListRestoreJobs (p. 152)• ListTags (p. 154)
61
AWS Backup 開発者ガイドActions
• PutBackupVaultAccessPolicy (p. 156)• PutBackupVaultNotifications (p. 158)• StartBackupJob (p. 160)• StartCopyJob (p. 164)• StartRestoreJob (p. 167)• StopBackupJob (p. 170)• TagResource (p. 172)• UntagResource (p. 174)• UpdateBackupPlan (p. 176)• UpdateRecoveryPointLifecycle (p. 179)• UpdateRegionSettings (p. 182)
62
AWS Backup 開発者ガイドCreateBackupPlan
CreateBackupPlanBackup plans are documents that contain information that AWS Backup uses to schedule tasks that createrecovery points of resources.
If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException isreturned.
Request SyntaxPUT /backup/plans/ HTTP/1.1Content-type: application/json
{ "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number } } ], "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ] }, "BackupPlanTags": { "string" : "string" }, "CreatorRequestId": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
BackupPlan (p. 63)
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Type: BackupPlanInput (p. 189) object
63
AWS Backup 開発者ガイドCreateBackupPlan
Required: YesBackupPlanTags (p. 63)
To help organize your resources, you can assign your own metadata to the resources that you create.Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
Type: String to string map
Required: NoCreatorRequestId (p. 63)
Identifies the request and allows failed requests to be retried without the risk of executing the operationtwice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan isreturned. This parameter is optional.
Type: String
Required: No
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "VersionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanArn (p. 64)
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: StringBackupPlanId (p. 64)
Uniquely identifies a backup plan.
Type: StringCreationDate (p. 64)
The date and time that a backup plan is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
64
AWS Backup 開発者ガイドCreateBackupPlan
VersionId (p. 64)
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Theycannot be edited.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
AlreadyExistsException
The required resource already exists.
HTTP Status Code: 400InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
65
AWS Backup 開発者ガイドCreateBackupSelection
CreateBackupSelectionCreates a JSON document that specifies a set of resources to assign to a backup plan. Resources can beincluded by specifying patterns for a ListOfTags and selected Resources.
For example, consider the following patterns:
• Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
• ConditionKey:"department"
ConditionValue:"finance"
ConditionType:"STRINGEQUALS"
• ConditionKey:"importance"
ConditionValue:"critical"
ConditionType:"STRINGEQUALS"
Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that aretagged as "department=finance", "importance=critical", in addition to an EBS volume with thespecified volume Id.
Resources and conditions are additive in that all resources that match the pattern are selected. Thisshouldn't be confused with a logical AND, where all conditions must match. The matching patterns arelogically 'put together using the OR operator. In other words, all patterns that match are selected forbackup.
Request Syntax
PUT /backup/plans/backupPlanId/selections/ HTTP/1.1Content-type: application/json
{ "BackupSelection": { "IamRoleArn": "string", "ListOfTags": [ { "ConditionKey": "string", "ConditionType": "string", "ConditionValue": "string" } ], "Resources": [ "string" ], "SelectionName": "string" }, "CreatorRequestId": "string"}
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 66)
Uniquely identifies the backup plan to be associated with the selection of resources.
66
AWS Backup 開発者ガイドCreateBackupSelection
Request BodyThe request accepts the following data in JSON format.
BackupSelection (p. 66)
Specifies the body of a request to assign a set of resources to a backup plan.
Type: BackupSelection (p. 197) object
Required: YesCreatorRequestId (p. 66)
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: String
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlanId": "string", "CreationDate": number, "SelectionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanId (p. 67)
Uniquely identifies a backup plan.
Type: StringCreationDate (p. 67)
The date and time a backup selection is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampSelectionId (p. 67)
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
67
AWS Backup 開発者ガイドCreateBackupSelection
AlreadyExistsException
The required resource already exists.
HTTP Status Code: 400InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
68
AWS Backup 開発者ガイドCreateBackupVault
CreateBackupVaultCreates a logical container where backups are stored. A CreateBackupVault request includes a name,optionally one or more resource tags, an encryption key, and a request ID.
Note
Sensitive data, such as passport numbers, should not be included the name of a backup vault.
Request SyntaxPUT /backup-vaults/backupVaultName HTTP/1.1Content-type: application/json
{ "BackupVaultTags": { "string" : "string" }, "CreatorRequestId": "string", "EncryptionKeyArn": "string"}
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 69)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request accepts the following data in JSON format.
BackupVaultTags (p. 69)
Metadata that you can assign to help organize the resources that you create. Each tag is a key-valuepair.
Type: String to string map
Required: NoCreatorRequestId (p. 69)
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: String
Required: NoEncryptionKeyArn (p. 69)
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
69
AWS Backup 開発者ガイドCreateBackupVault
Type: String
Required: No
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 70)
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultName (p. 70)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$CreationDate (p. 70)
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
AlreadyExistsException
The required resource already exists.
HTTP Status Code: 400InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
70
AWS Backup 開発者ガイドCreateBackupVault
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
71
AWS Backup 開発者ガイドDeleteBackupPlan
DeleteBackupPlanDeletes a backup plan. A backup plan can only be deleted after all associated selections of resources havebeen deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, ifany, will still exist.
Request Syntax
DELETE /backup/plans/backupPlanId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 72)
Uniquely identifies a backup plan.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanArn": "string", "BackupPlanId": "string", "DeletionDate": number, "VersionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanArn (p. 72)
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: StringBackupPlanId (p. 72)
Uniquely identifies a backup plan.
Type: String
72
AWS Backup 開発者ガイドDeleteBackupPlan
DeletionDate (p. 72)
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampVersionId (p. 72)
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Version Ids cannot be edited.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
73
AWS Backup 開発者ガイドDeleteBackupPlan
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
74
AWS Backup 開発者ガイドDeleteBackupSelection
DeleteBackupSelectionDeletes the resource selection associated with a backup plan that is specified by the SelectionId.
Request SyntaxDELETE /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 75)
Uniquely identifies a backup plan.selectionId (p. 75)
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
75
AWS Backup 開発者ガイドDeleteBackupSelection
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
76
AWS Backup 開発者ガイドDeleteBackupVault
DeleteBackupVaultDeletes the backup vault identified by its name. A vault can be deleted only if it is empty.
Request SyntaxDELETE /backup-vaults/backupVaultName HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 77)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
77
AWS Backup 開発者ガイドDeleteBackupVault
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
78
AWS Backup 開発者ガイドDeleteBackupVaultAccessPolicy
DeleteBackupVaultAccessPolicyDeletes the policy document that manages permissions on a backup vault.
Request SyntaxDELETE /backup-vaults/backupVaultName/access-policy HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 79)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
79
AWS Backup 開発者ガイドDeleteBackupVaultAccessPolicy
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
80
AWS Backup 開発者ガイドDeleteBackupVaultNotifications
DeleteBackupVaultNotificationsDeletes event notifications for the specified backup vault.
Request SyntaxDELETE /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 81)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
81
AWS Backup 開発者ガイドDeleteBackupVaultNotifications
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
82
AWS Backup 開発者ガイドDeleteRecoveryPoint
DeleteRecoveryPointDeletes the recovery point specified by a recovery point ID.
Request Syntax
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 83)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$recoveryPointArn (p. 83)
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400
83
AWS Backup 開発者ガイドDeleteRecoveryPoint
MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
84
AWS Backup 開発者ガイドDescribeBackupJob
DescribeBackupJobReturns metadata associated with creating a backup of a resource.
Request Syntax
GET /backup-jobs/backupJobId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupJobId (p. 85)
Uniquely identifies a request to AWS Backup to back up a resource.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupJobId": "string", "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "ExpectedCompletionDate": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
85
AWS Backup 開発者ガイドDescribeBackupJob
BackupJobId (p. 85)
Uniquely identifies a request to AWS Backup to back up a resource.
Type: StringBackupSizeInBytes (p. 85)
The size, in bytes, of a backup.
Type: LongBackupVaultArn (p. 85)
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultName (p. 85)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$BytesTransferred (p. 85)
The size in bytes transferred to a backup vault at the time that the job status was queried.
Type: LongCompletionDate (p. 85)
The date and time that a job to create a backup job is completed, in Unix format and CoordinatedUniversal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampCreatedBy (p. 85)
Contains identifying information about the creation of a backup job, including the BackupPlanArn,BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to createit.
Type: RecoveryPointCreator (p. 215) objectCreationDate (p. 85)
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampExpectedCompletionDate (p. 85)
The date and time that a job to back up resources is expected to be completed, in Unix formatand Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurateto milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
Type: Timestamp
86
AWS Backup 開発者ガイドDescribeBackupJob
IamRoleArn (p. 85)
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: StringPercentDone (p. 85)
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Type: StringRecoveryPointArn (p. 85)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: StringResourceArn (p. 85)
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resourcetype.
Type: StringResourceType (p. 85)
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (AmazonEBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$StartBy (p. 85)
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must bestarted before it is canceled. The value is calculated by adding the start window to the scheduled time.So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampState (p. 85)
The current state of a resource recovery point.
Type: String
Valid Values: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED |FAILED | EXPIRED
StatusMessage (p. 85)
A detailed message explaining the status of the job to back up a resource.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
87
AWS Backup 開発者ガイドDescribeBackupJob
DependencyFailureException
A dependent AWS service or resource returned an error to the AWS Backup service, and the actioncannot be completed.
HTTP Status Code: 500InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
88
AWS Backup 開発者ガイドDescribeBackupVault
DescribeBackupVaultReturns metadata about a backup vault specified by its name.
Request SyntaxGET /backup-vaults/backupVaultName HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 89)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number, "CreatorRequestId": "string", "EncryptionKeyArn": "string", "NumberOfRecoveryPoints": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 89)
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultName (p. 89)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Type: String
89
AWS Backup 開発者ガイドDescribeBackupVault
CreationDate (p. 89)
The date and time that a backup vault is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampCreatorRequestId (p. 89)
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: StringEncryptionKeyArn (p. 89)
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Type: StringNumberOfRecoveryPoints (p. 89)
The number of recovery points that are stored in a backup vault.
Type: Long
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
90
AWS Backup 開発者ガイドDescribeBackupVault
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
91
AWS Backup 開発者ガイドDescribeCopyJob
DescribeCopyJobReturns metadata associated with creating a copy of a resource.
Request SyntaxGET /copy-jobs/copyJobId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
copyJobId (p. 92)
Uniquely identifies a copy job.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "CopyJob": { "BackupSizeInBytes": number, "CompletionDate": number, "CopyJobId": "string", "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "DestinationBackupVaultArn": "string", "DestinationRecoveryPointArn": "string", "IamRoleArn": "string", "ResourceArn": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "SourceRecoveryPointArn": "string", "State": "string", "StatusMessage": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CopyJob (p. 92)
Contains detailed information about a copy job.
92
AWS Backup 開発者ガイドDescribeCopyJob
Type: CopyJob (p. 205) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
93
AWS Backup 開発者ガイドDescribeProtectedResource
DescribeProtectedResourceReturns information about a saved resource, including the last time it was backed up, its Amazon ResourceName (ARN), and the AWS service type of the saved resource.
Request SyntaxGET /resources/resourceArn HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 94)
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN dependson the resource type.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "LastBackupTime": number, "ResourceArn": "string", "ResourceType": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
LastBackupTime (p. 94)
The date and time that a resource was last backed up, in Unix format and Coordinated UniversalTime (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampResourceArn (p. 94)
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: StringResourceType (p. 94)
The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDSdatabase.
94
AWS Backup 開発者ガイドDescribeProtectedResource
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
95
AWS Backup 開発者ガイドDescribeRecoveryPoint
DescribeRecoveryPointReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Request SyntaxGET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 96)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$recoveryPointArn (p. 96)
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "CalculatedLifecycle": { "DeleteAt": number, "MoveToColdStorageAt": number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "IamRoleArn": "string", "IsEncrypted": boolean, "LastRestoreTime": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number
96
AWS Backup 開発者ガイドDescribeRecoveryPoint
}, "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "Status": "string", "StorageClass": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupSizeInBytes (p. 96)
The size, in bytes, of a backup.
Type: LongBackupVaultArn (p. 96)
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultName (p. 96)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$CalculatedLifecycle (p. 96)
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Type: CalculatedLifecycle (p. 202) objectCompletionDate (p. 96)
The date and time that a job to create a recovery point is completed, in Unix format and CoordinatedUniversal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampCreatedBy (p. 96)
Contains identifying information about the creation of a recovery point, including the BackupPlanArn,BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
Type: RecoveryPointCreator (p. 215) objectCreationDate (p. 96)
The date and time that a recovery point is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
97
AWS Backup 開発者ガイドDescribeRecoveryPoint
EncryptionKeyArn (p. 96)
The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Type: StringIamRoleArn (p. 96)
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: StringIsEncrypted (p. 96)
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if therecovery point is not encrypted.
Type: BooleanLastRestoreTime (p. 96)
The date and time that a recovery point was last restored, in Unix format and Coordinated UniversalTime (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampLifecycle (p. 96)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) objectRecoveryPointArn (p. 96)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: StringResourceArn (p. 96)
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resourcetype.
Type: StringResourceType (p. 96)
The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store(Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$Status (p. 96)
A status code specifying the state of the recovery point.
98
AWS Backup 開発者ガイドDescribeRecoveryPoint
Note
A partial status indicates that the recovery point was not successfully re-created and must beretried.
Type: String
Valid Values: COMPLETED | PARTIAL | DELETING | EXPIREDStorageClass (p. 96)
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
Type: String
Valid Values: WARM | COLD | DELETED
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
99
AWS Backup 開発者ガイドDescribeRecoveryPoint
100
AWS Backup 開発者ガイドDescribeRegionSettings
DescribeRegionSettingsReturns the current service opt-in settings for the Region. If the service has a value set to true, AWSBackup attempts to protect that service's resources in this Region, when included in an on-demand backupor scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt toprotect that service's resources in this Region.
Request Syntax
GET /account-settings HTTP/1.1
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "ResourceTypeOptInPreference": { "string" : boolean }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ResourceTypeOptInPreference (p. 101)
Returns a list of all services along with the opt-in preferences in the region.
Type: String to boolean map
Key Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
101
AWS Backup 開発者ガイドDescribeRegionSettings
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
102
AWS Backup 開発者ガイドDescribeRestoreJob
DescribeRestoreJobReturns metadata associated with a restore job that is specified by a job ID.
Request SyntaxGET /restore-jobs/restoreJobId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
restoreJobId (p. 103)
Uniquely identifies the job that restores a recovery point.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupSizeInBytes": number, "CompletionDate": number, "CreatedResourceArn": "string", "CreationDate": number, "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RestoreJobId": "string", "Status": "string", "StatusMessage": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupSizeInBytes (p. 103)
The size, in bytes, of the restored resource.
Type: LongCompletionDate (p. 103)
The date and time that a job to restore a recovery point is completed, in Unix format and CoordinatedUniversal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
103
AWS Backup 開発者ガイドDescribeRestoreJob
Type: TimestampCreatedResourceArn (p. 103)
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is beingrestored. The format of the ARN depends on the resource type of the backed-up resource.
Type: StringCreationDate (p. 103)
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampExpectedCompletionTimeMinutes (p. 103)
The amount of time in minutes that a job restoring a recovery point is expected to take.
Type: LongIamRoleArn (p. 103)
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: StringPercentDone (p. 103)
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Type: StringRecoveryPointArn (p. 103)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: StringRestoreJobId (p. 103)
Uniquely identifies the job that restores a recovery point.
Type: StringStatus (p. 103)
Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.
Type: String
Valid Values: PENDING | RUNNING | COMPLETED | ABORTED | FAILEDStatusMessage (p. 103)
A detailed message explaining the status of a job to restore a recovery point.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
104
AWS Backup 開発者ガイドDescribeRestoreJob
DependencyFailureException
A dependent AWS service or resource returned an error to the AWS Backup service, and the actioncannot be completed.
HTTP Status Code: 500InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
105
AWS Backup 開発者ガイドExportBackupPlanTemplate
ExportBackupPlanTemplateReturns the backup plan that is specified by the plan ID as a backup template.
Request Syntax
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 106)
Uniquely identifies a backup plan.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanTemplateJson": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanTemplateJson (p. 106)
The body of a backup plan template in JSON format.
Note
This is a signed JSON document that cannot be modified before being passed toGetBackupPlanFromJSON.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
106
AWS Backup 開発者ガイドExportBackupPlanTemplate
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
107
AWS Backup 開発者ガイドGetBackupPlan
GetBackupPlanReturns the body of a backup plan in JSON format, in addition to plan metadata.
Request SyntaxGET /backup/plans/backupPlanId/?versionId=VersionId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 108)
Uniquely identifies a backup plan.VersionId (p. 108)
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Version IDs cannot be edited.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number } } ], "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleId": "string", "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ]
108
AWS Backup 開発者ガイドGetBackupPlan
}, "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "VersionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlan (p. 108)
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Type: BackupPlan (p. 188) objectBackupPlanArn (p. 108)
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: StringBackupPlanId (p. 108)
Uniquely identifies a backup plan.
Type: StringCreationDate (p. 108)
The date and time that a backup plan is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampCreatorRequestId (p. 108)
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: StringDeletionDate (p. 108)
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampLastExecutionDate (p. 108)
The last time a job to back up resources was executed with this backup plan. A date and time, inUnix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurateto milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
109
AWS Backup 開発者ガイドGetBackupPlan
Type: TimestampVersionId (p. 108)
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Version IDs cannot be edited.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
110
AWS Backup 開発者ガイドGetBackupPlanFromJSON
GetBackupPlanFromJSONReturns a valid JSON document specifying a backup plan or an error.
Request SyntaxPOST /backup/template/json/toPlan HTTP/1.1Content-type: application/json
{ "BackupPlanTemplateJson": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
BackupPlanTemplateJson (p. 111)
A customer-supplied backup plan document in JSON format.
Type: String
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number } } ], "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleId": "string", "RuleName": "string",
111
AWS Backup 開発者ガイドGetBackupPlanFromJSON
"ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ] }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlan (p. 111)
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Type: BackupPlan (p. 188) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
112
AWS Backup 開発者ガイドGetBackupPlanFromJSON
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
113
AWS Backup 開発者ガイドGetBackupPlanFromTemplate
GetBackupPlanFromTemplateReturns the template specified by its templateId as a backup plan.
Request Syntax
GET /backup/template/plans/templateId/toPlan HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
templateId (p. 114)
Uniquely identifies a stored backup plan template.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanDocument": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number } } ], "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleId": "string", "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ] }}
114
AWS Backup 開発者ガイドGetBackupPlanFromTemplate
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanDocument (p. 114)
Returns the body of a backup plan based on the target template, including the name, rules, and backupvault of the plan.
Type: BackupPlan (p. 188) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
115
AWS Backup 開発者ガイドGetBackupSelection
GetBackupSelectionReturns selection metadata and a document in JSON format that specifies a list of resources that areassociated with a backup plan.
Request SyntaxGET /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 116)
Uniquely identifies a backup plan.selectionId (p. 116)
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlanId": "string", "BackupSelection": { "IamRoleArn": "string", "ListOfTags": [ { "ConditionKey": "string", "ConditionType": "string", "ConditionValue": "string" } ], "Resources": [ "string" ], "SelectionName": "string" }, "CreationDate": number, "CreatorRequestId": "string", "SelectionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanId (p. 116)
Uniquely identifies a backup plan.
116
AWS Backup 開発者ガイドGetBackupSelection
Type: StringBackupSelection (p. 116)
Specifies the body of a request to assign a set of resources to a backup plan.
Type: BackupSelection (p. 197) objectCreationDate (p. 116)
The date and time a backup selection is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampCreatorRequestId (p. 116)
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: StringSelectionId (p. 116)
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
117
AWS Backup 開発者ガイドGetBackupSelection
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
118
AWS Backup 開発者ガイドGetBackupVaultAccessPolicy
GetBackupVaultAccessPolicyReturns the access policy document that is associated with the named backup vault.
Request Syntax
GET /backup-vaults/backupVaultName/access-policy HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 119)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "BackupVaultName": "string", "Policy": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 119)
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultName (p. 119)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Type: String
119
AWS Backup 開発者ガイドGetBackupVaultAccessPolicy
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$Policy (p. 119)
The backup vault access policy document in JSON format.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
120
AWS Backup 開発者ガイドGetBackupVaultNotifications
GetBackupVaultNotificationsReturns event notifications for the specified backup vault.
Request SyntaxGET /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 121)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "BackupVaultEvents": [ "string" ], "BackupVaultName": "string", "SNSTopicArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 121)
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringBackupVaultEvents (p. 121)
An array of events that indicate the status of jobs to back up resources to the backup vault.
Type: Array of strings
Valid Values: BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL| BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED |
121
AWS Backup 開発者ガイドGetBackupVaultNotifications
RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED| COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED |RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED
BackupVaultName (p. 121)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the Region where they are created. They consist oflowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$SNSTopicArn (p. 121)
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; forexample, arn:aws:sns:us-west-2:111122223333:MyTopic.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3
122
AWS Backup 開発者ガイドGetBackupVaultNotifications
• AWS SDK for Python• AWS SDK for Ruby V3
123
AWS Backup 開発者ガイドGetRecoveryPointRestoreMetadata
GetRecoveryPointRestoreMetadataReturns a set of metadata key-value pairs that were used to create the backup.
Request SyntaxGET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 124)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$recoveryPointArn (p. 124)
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "RecoveryPointArn": "string", "RestoreMetadata": { "string" : "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 124)
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
124
AWS Backup 開発者ガイドGetRecoveryPointRestoreMetadata
RecoveryPointArn (p. 124)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: StringRestoreMetadata (p. 124)
The set of metadata key-value pairs that describes the original configuration of the backed-upresource. These values vary depending on the service that is being restored.
Type: String to string map
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
125
AWS Backup 開発者ガイドGetSupportedResourceTypes
GetSupportedResourceTypesReturns the AWS resource types supported by AWS Backup.
Request SyntaxGET /supported-resource-types HTTP/1.1
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "ResourceTypes": [ "string" ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ResourceTypes (p. 126)
Contains a string with the supported AWS resource types:• EBS for Amazon Elastic Block Store• Storage Gateway for AWS Storage Gateway• RDS for Amazon Relational Database Service• DDB for Amazon DynamoDB• EFS for Amazon Elastic File System
Type: Array of strings
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
126
AWS Backup 開発者ガイドGetSupportedResourceTypes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
127
AWS Backup 開発者ガイドListBackupJobs
ListBackupJobsReturns metadata about your backup jobs.
Request Syntax
GET /backup-jobs/?backupVaultName=ByBackupVaultName&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
ByBackupVaultName (p. 128)
Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identifiedby names that are unique to the account used to create them and the AWS Region where they arecreated. They consist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$ByCreatedAfter (p. 128)
Returns only backup jobs that were created after the specified date.ByCreatedBefore (p. 128)
Returns only backup jobs that were created before the specified date.ByResourceArn (p. 128)
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).ByResourceType (p. 128)
Returns only backup jobs for the specified resources:• DynamoDB for Amazon DynamoDB• EBS for Amazon Elastic Block Store• EFS for Amazon Elastic File System• RDS for Amazon Relational Database Service• Storage Gateway for AWS Storage Gateway
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$ByState (p. 128)
Returns only backup jobs that are in the specified state.
Valid Values: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED |FAILED | EXPIRED
MaxResults (p. 128)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
128
AWS Backup 開発者ガイドListBackupJobs
NextToken (p. 128)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupJobs": [ { "BackupJobId": "string", "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "ExpectedCompletionDate": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupJobs (p. 129)
An array of structures containing metadata about your backup jobs returned in JSON format.
Type: Array of BackupJob (p. 185) objectsNextToken (p. 129)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
129
AWS Backup 開発者ガイドListBackupJobs
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
130
AWS Backup 開発者ガイドListBackupPlans
ListBackupPlansReturns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs,creation and deletion dates, version IDs, plan names, and creator request IDs.
Request SyntaxGET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
IncludeDeleted (p. 131)
A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.MaxResults (p. 131)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 131)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlansList": [ { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanName": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "VersionId": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
131
AWS Backup 開発者ガイドListBackupPlans
The following data is returned in JSON format by the service.
BackupPlansList (p. 131)
An array of backup plan list items containing metadata about your saved backup plans.
Type: Array of BackupPlansListMember (p. 190) objectsNextToken (p. 131)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
132
AWS Backup 開発者ガイドListBackupPlanTemplates
ListBackupPlanTemplatesReturns metadata of your saved backup plan templates, including the template ID, name, and the creationand deletion dates.
Request Syntax
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 133)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 133)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanTemplatesList": [ { "BackupPlanTemplateId": "string", "BackupPlanTemplateName": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanTemplatesList (p. 133)
An array of template list items containing metadata about your saved templates.
Type: Array of BackupPlanTemplatesListMember (p. 192) objects
133
AWS Backup 開発者ガイドListBackupPlanTemplates
NextToken (p. 133)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
134
AWS Backup 開発者ガイドListBackupPlanVersions
ListBackupPlanVersionsReturns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup planIDs, creation and deletion dates, plan names, and version IDs.
Request SyntaxGET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 135)
Uniquely identifies a backup plan.MaxResults (p. 135)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 135)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupPlanVersionsList": [ { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanName": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "VersionId": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
135
AWS Backup 開発者ガイドListBackupPlanVersions
The following data is returned in JSON format by the service.
BackupPlanVersionsList (p. 135)
An array of version list items containing metadata about your backup plans.
Type: Array of BackupPlansListMember (p. 190) objectsNextToken (p. 135)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
136
AWS Backup 開発者ガイドListBackupSelections
ListBackupSelectionsReturns an array containing metadata of the resources associated with the target backup plan.
Request SyntaxGET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 137)
Uniquely identifies a backup plan.MaxResults (p. 137)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 137)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupSelectionsList": [ { "BackupPlanId": "string", "CreationDate": number, "CreatorRequestId": "string", "IamRoleArn": "string", "SelectionId": "string", "SelectionName": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
137
AWS Backup 開発者ガイドListBackupSelections
BackupSelectionsList (p. 137)
An array of backup selection list items containing metadata about each resource in the list.
Type: Array of BackupSelectionsListMember (p. 198) objectsNextToken (p. 137)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
138
AWS Backup 開発者ガイドListBackupVaults
ListBackupVaultsReturns a list of recovery point storage containers along with information about them.
Request SyntaxGET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 139)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 139)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BackupVaultList": [ { "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number, "CreatorRequestId": "string", "EncryptionKeyArn": "string", "NumberOfRecoveryPoints": number } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultList (p. 139)
An array of backup vault list members containing vault metadata, including Amazon Resource Name(ARN), display name, creation date, number of saved recovery points, and encryption information if theresources saved in the backup vault are encrypted.
139
AWS Backup 開発者ガイドListBackupVaults
Type: Array of BackupVaultListMember (p. 200) objectsNextToken (p. 139)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
140
AWS Backup 開発者ガイドListCopyJobs
ListCopyJobsReturns metadata about your copy jobs.
Request SyntaxGET /copy-jobs/?createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
ByCreatedAfter (p. 141)
Returns only copy jobs that were created after the specified date.ByCreatedBefore (p. 141)
Returns only copy jobs that were created before the specified date.ByDestinationVaultArn (p. 141)
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; forexample, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
ByResourceArn (p. 141)
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).ByResourceType (p. 141)
Returns only backup jobs for the specified resources:• EBS for Amazon Elastic Block Store• EFS for Amazon Elastic File System• RDS for Amazon Relational Database Service• Storage Gateway for AWS Storage Gateway
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$ByState (p. 141)
Returns only copy jobs that are in the specified state.
Valid Values: CREATED | RUNNING | COMPLETED | FAILEDMaxResults (p. 141)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 141)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
141
AWS Backup 開発者ガイドListCopyJobs
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "CopyJobs": [ { "BackupSizeInBytes": number, "CompletionDate": number, "CopyJobId": "string", "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "DestinationBackupVaultArn": "string", "DestinationRecoveryPointArn": "string", "IamRoleArn": "string", "ResourceArn": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "SourceRecoveryPointArn": "string", "State": "string", "StatusMessage": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CopyJobs (p. 142)
An array of structures containing metadata about your copy jobs returned in JSON format.
Type: Array of CopyJob (p. 205) objectsNextToken (p. 142)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
142
AWS Backup 開発者ガイドListCopyJobs
ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
143
AWS Backup 開発者ガイドListProtectedResources
ListProtectedResourcesReturns an array of resources successfully backed up by AWS Backup, including the time the resource wassaved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Request SyntaxGET /resources/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 144)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 144)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "Results": [ { "LastBackupTime": number, "ResourceArn": "string", "ResourceType": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 144)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
144
AWS Backup 開発者ガイドListProtectedResources
Type: StringResults (p. 144)
An array of resources successfully backed up by AWS Backup including the time the resource wassaved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Type: Array of ProtectedResource (p. 209) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
145
AWS Backup 開発者ガイドListRecoveryPointsByBackupVault
ListRecoveryPointsByBackupVaultReturns detailed information about the recovery points stored in a backup vault.
Request SyntaxGET /backup-vaults/backupVaultName/recovery-points/?backupPlanId=ByBackupPlanId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 146)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$ByBackupPlanId (p. 146)
Returns only recovery points that match the specified backup plan ID.ByCreatedAfter (p. 146)
Returns only recovery points that were created after the specified timestamp.ByCreatedBefore (p. 146)
Returns only recovery points that were created before the specified timestamp.ByResourceArn (p. 146)
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).ByResourceType (p. 146)
Returns only recovery points that match the specified resource type.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$MaxResults (p. 146)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 146)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
146
AWS Backup 開発者ガイドListRecoveryPointsByBackupVault
{ "NextToken": "string", "RecoveryPoints": [ { "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "CalculatedLifecycle": { "DeleteAt": number, "MoveToColdStorageAt": number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "IamRoleArn": "string", "IsEncrypted": boolean, "LastRestoreTime": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "Status": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 146)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: StringRecoveryPoints (p. 146)
An array of objects that contain detailed information about recovery points saved in a backup vault.
Type: Array of RecoveryPointByBackupVault (p. 210) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
147
AWS Backup 開発者ガイドListRecoveryPointsByBackupVault
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
148
AWS Backup 開発者ガイドListRecoveryPointsByResource
ListRecoveryPointsByResourceReturns detailed information about recovery points of the type specified by a resource Amazon ResourceName (ARN).
Request Syntax
GET /resources/resourceArn/recovery-points/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 149)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 149)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
resourceArn (p. 149)
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "RecoveryPoints": [ { "BackupSizeBytes": number, "BackupVaultName": "string", "CreationDate": number, "EncryptionKeyArn": "string", "RecoveryPointArn": "string", "Status": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
149
AWS Backup 開発者ガイドListRecoveryPointsByResource
The following data is returned in JSON format by the service.
NextToken (p. 149)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: StringRecoveryPoints (p. 149)
An array of objects that contain detailed information about recovery points of the specified resourcetype.
Type: Array of RecoveryPointByResource (p. 213) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
150
AWS Backup 開発者ガイドListRecoveryPointsByResource
151
AWS Backup 開発者ガイドListRestoreJobs
ListRestoreJobsReturns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about therecovery process.
Request Syntax
GET /restore-jobs/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 152)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 152)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "RestoreJobs": [ { "BackupSizeInBytes": number, "CompletionDate": number, "CreatedResourceArn": "string", "CreationDate": number, "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RestoreJobId": "string", "Status": "string", "StatusMessage": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
152
AWS Backup 開発者ガイドListRestoreJobs
The following data is returned in JSON format by the service.
NextToken (p. 152)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: StringRestoreJobs (p. 152)
An array of objects that contain detailed information about jobs to restore saved resources.
Type: Array of RestoreJobsListMember (p. 216) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
153
AWS Backup 開発者ガイドListTags
ListTagsReturns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
Note
ListTags are currently only supported with Amazon EFS backups.
Request Syntax
GET /tags/resourceArn/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
MaxResults (p. 154)
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 154)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
resourceArn (p. 154)
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN dependson the type of resource. Valid targets for ListTags are recovery points, backup plans, and backupvaults.
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "Tags": { "string" : "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
154
AWS Backup 開発者ガイドListTags
NextToken (p. 154)
The next item following a partial list of returned items. For example, if a request is made to returnmaxResults number of items, NextToken allows you to return more items in your list starting at thelocation pointed to by the next token.
Type: StringTags (p. 154)
To help organize your resources, you can assign your own metadata to the resources you create. Eachtag is a key-value pair.
Type: String to string map
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
155
AWS Backup 開発者ガイドPutBackupVaultAccessPolicy
PutBackupVaultAccessPolicySets a resource-based policy that is used to manage access permissions on the target backup vault.Requires a backup vault name and an access policy document in JSON format.
Request Syntax
PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1Content-type: application/json
{ "Policy": "string"}
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 156)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request accepts the following data in JSON format.
Policy (p. 156)
The backup vault access policy document in JSON format.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
156
AWS Backup 開発者ガイドPutBackupVaultAccessPolicy
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
157
AWS Backup 開発者ガイドPutBackupVaultNotifications
PutBackupVaultNotificationsTurns on notifications on a backup vault for the specified topic and events.
Request SyntaxPUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1Content-type: application/json
{ "BackupVaultEvents": [ "string" ], "SNSTopicArn": "string"}
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 158)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Request BodyThe request accepts the following data in JSON format.
BackupVaultEvents (p. 158)
An array of events that indicate the status of jobs to back up resources to the backup vault.
Type: Array of strings
Valid Values: BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL| BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED |RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED| COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED |RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED
Required: YesSNSTopicArn (p. 158)
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example,arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
Type: String
Required: Yes
Response SyntaxHTTP/1.1 200
158
AWS Backup 開発者ガイドPutBackupVaultNotifications
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
159
AWS Backup 開発者ガイドStartBackupJob
StartBackupJobStarts a job to create a one-time backup of the specified resource.
Request SyntaxPUT /backup-jobs HTTP/1.1Content-type: application/json
{ "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
BackupVaultName (p. 160)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: YesCompleteWindowMinutes (p. 160)
A value in minutes after a backup job is successfully started before it must be completed or it will becanceled by AWS Backup. This value is optional.
Type: Long
Required: NoIamRoleArn (p. 160)
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
160
AWS Backup 開発者ガイドStartBackupJob
Required: YesIdempotencyToken (p. 160)
A customer chosen string that can be used to distinguish between calls to StartBackupJob.
Type: String
Required: NoLifecycle (p. 160)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) object
Required: NoRecoveryPointTags (p. 160)
To help organize your resources, you can assign your own metadata to the resources that you create.Each tag is a key-value pair.
Type: String to string map
Required: NoResourceArn (p. 160)
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN dependson the resource type.
Type: String
Required: YesStartWindowMinutes (p. 160)
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't startsuccessfully. This value is optional.
Type: Long
Required: No
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupJobId": "string", "CreationDate": number, "RecoveryPointArn": "string"}
161
AWS Backup 開発者ガイドStartBackupJob
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupJobId (p. 161)
Uniquely identifies a request to AWS Backup to back up a resource.
Type: StringCreationDate (p. 161)
The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampRecoveryPointArn (p. 161)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
162
AWS Backup 開発者ガイドStartBackupJob
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
163
AWS Backup 開発者ガイドStartCopyJob
StartCopyJobStarts a job to create a one-time copy of the specified resource.
Request Syntax
PUT /copy-jobs HTTP/1.1Content-type: application/json
{ "DestinationBackupVaultArn": "string", "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointArn": "string", "SourceBackupVaultName": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
DestinationBackupVaultArn (p. 164)
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; forexample, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: YesIamRoleArn (p. 164)
Specifies the IAM role ARN used to copy the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: YesIdempotencyToken (p. 164)
A customer chosen string that can be used to distinguish between calls to StartCopyJob.
Type: String
Required: NoLifecycle (p. 164)
Contains an array of Transition objects specifying how long in days before a recovery pointtransitions to cold storage or is deleted.
164
AWS Backup 開発者ガイドStartCopyJob
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transitionto cold after days” setting. The “transition to cold after days” setting cannot be changed after a backuphas been transitioned to cold.
Type: Lifecycle (p. 208) object
Required: NoRecoveryPointArn (p. 164)
An ARN that uniquely identifies a recovery point to use for the copy job; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: YesSourceBackupVaultName (p. 164)
The name of a logical source container where backups are stored. Backup vaults are identified bynames that are unique to the account used to create them and the AWS Region where they arecreated. They consist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: Yes
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "CopyJobId": "string", "CreationDate": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CopyJobId (p. 165)
Uniquely identifies a copy job.
Type: StringCreationDate (p. 165)
The date and time that a copy job is started, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
165
AWS Backup 開発者ガイドStartCopyJob
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
166
AWS Backup 開発者ガイドStartRestoreJob
StartRestoreJobRecovers the saved resource identified by an Amazon Resource Name (ARN).
If the resource ARN is included in the request, then the last complete backup of that resource is recovered.If the ARN of a recovery point is supplied, then that recovery point is restored.
Request Syntax
PUT /restore-jobs HTTP/1.1Content-type: application/json
{ "IamRoleArn": "string", "IdempotencyToken": "string", "Metadata": { "string" : "string" }, "RecoveryPointArn": "string", "ResourceType": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
IamRoleArn (p. 167)
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the targetrecovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: YesIdempotencyToken (p. 167)
A customer chosen string that can be used to distinguish between calls to StartRestoreJob.
Type: String
Required: NoMetadata (p. 167)
A set of metadata key-value pairs. Contains information, such as a resource name, required to restorea recovery point.
You can get configuration metadata about a resource at the time it was backed up by callingGetRecoveryPointRestoreMetadata. However, values in addition to those provided byGetRecoveryPointRestoreMetadata might be required to restore a resource. For example, youmight need to provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS)instance:
167
AWS Backup 開発者ガイドStartRestoreJob
• file-system-id: ID of the Amazon EFS file system that is backed up by AWS Backup. Returnedin GetRecoveryPointRestoreMetadata.
• Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId isspecified, Encrypted must be set to true.
• KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system.• PerformanceMode: Specifies the throughput mode of the file system.• CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.• newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new
Amazon EFS file system.
Type: String to string map
Required: YesRecoveryPointArn (p. 167)
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: YesResourceType (p. 167)
Starts a job to restore a recovery point for one of the following resources:• EBS for Amazon Elastic Block Store• Storage Gateway for AWS Storage Gateway• RDS for Amazon Relational Database Service• DDB for Amazon DynamoDB• EFS for Amazon Elastic File System
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: No
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "RestoreJobId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
RestoreJobId (p. 168)
Uniquely identifies the job that restores a recovery point.
168
AWS Backup 開発者ガイドStartRestoreJob
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
169
AWS Backup 開発者ガイドStopBackupJob
StopBackupJobAttempts to cancel a job to create a one-time backup of a resource.
Request SyntaxPOST /backup-jobs/backupJobId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
backupJobId (p. 170)
Uniquely identifies a request to AWS Backup to back up a resource.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400InvalidRequestException
Indicates that something is wrong with the input to the request. For example, a parameter is of thewrong type.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
170
AWS Backup 開発者ガイドStopBackupJob
ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
171
AWS Backup 開発者ガイドTagResource
TagResourceAssigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an AmazonResource Name (ARN).
Request Syntax
POST /tags/resourceArn HTTP/1.1Content-type: application/json
{ "Tags": { "string" : "string" }}
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 172)
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the taggedresource.
Request BodyThe request accepts the following data in JSON format.
Tags (p. 172)
Key-value pairs that are used to help organize your resources. You can assign your own metadata tothe resources you create.
Type: String to string map
Required: Yes
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
172
AWS Backup 開発者ガイドTagResource
HTTP Status Code: 400LimitExceededException
A limit in the request has been exceeded; for example, a maximum number of items allowed in arequest.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
173
AWS Backup 開発者ガイドUntagResource
UntagResourceRemoves a set of key-value pairs from a recovery point, backup plan, or backup vault identified by anAmazon Resource Name (ARN)
Request Syntax
POST /untag/resourceArn HTTP/1.1Content-type: application/json
{ "TagKeyList": [ "string" ]}
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 174)
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the taggedresource.
Request BodyThe request accepts the following data in JSON format.
TagKeyList (p. 174)
A list of keys to identify which key-value tags to remove from a resource.
Type: Array of strings
Required: Yes
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
174
AWS Backup 開発者ガイドUntagResource
MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
175
AWS Backup 開発者ガイドUpdateBackupPlan
UpdateBackupPlanReplaces the body of a saved backup plan identified by its backupPlanId with the input document inJSON format. The new version is uniquely identified by a VersionId.
Request SyntaxPOST /backup/plans/backupPlanId HTTP/1.1Content-type: application/json
{ "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "CopyActions": [ { "DestinationBackupVaultArn": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number } } ], "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ] }}
URI Request ParametersThe request requires the following URI parameters.
backupPlanId (p. 176)
Uniquely identifies a backup plan.
Request BodyThe request accepts the following data in JSON format.
BackupPlan (p. 176)
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Type: BackupPlanInput (p. 189) object
Required: Yes
176
AWS Backup 開発者ガイドUpdateBackupPlan
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "VersionId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupPlanArn (p. 177)
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: StringBackupPlanId (p. 177)
Uniquely identifies a backup plan.
Type: StringCreationDate (p. 177)
The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: TimestampVersionId (p. 177)
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Version Ids cannot be edited.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
177
AWS Backup 開発者ガイドUpdateBackupPlan
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
178
AWS Backup 開発者ガイドUpdateRecoveryPointLifecycle
UpdateRecoveryPointLifecycleSets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWSBackup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore,the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The“transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Request SyntaxPOST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1Content-type: application/json
{ "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }}
URI Request ParametersThe request requires the following URI parameters.
backupVaultName (p. 179)
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$recoveryPointArn (p. 179)
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Request BodyThe request accepts the following data in JSON format.
Lifecycle (p. 179)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) object
Required: No
179
AWS Backup 開発者ガイドUpdateRecoveryPointLifecycle
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "BackupVaultArn": "string", "CalculatedLifecycle": { "DeleteAt": number, "MoveToColdStorageAt": number }, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupVaultArn (p. 180)
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: StringCalculatedLifecycle (p. 180)
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Type: CalculatedLifecycle (p. 202) objectLifecycle (p. 180)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) objectRecoveryPointArn (p. 180)
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
180
AWS Backup 開発者ガイドUpdateRecoveryPointLifecycle
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ResourceNotFoundException
A resource that is required for the action doesn't exist.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
181
AWS Backup 開発者ガイドUpdateRegionSettings
UpdateRegionSettingsUpdates the current service opt-in settings for the Region. If the service has a value set to true, AWSBackup attempts to protect that service's resources in this Region, when included in an on-demand backupor scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt toprotect that service's resources in this Region.
Request Syntax
PUT /account-settings HTTP/1.1Content-type: application/json
{ "ResourceTypeOptInPreference": { "string" : boolean }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
ResourceTypeOptInPreference (p. 182)
Updates the list of services along with the opt-in preferences for the region.
Type: String to boolean map
Key Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: No
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 217).
InvalidParameterValueException
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
182
AWS Backup 開発者ガイドData Types
MissingParameterValueException
Indicates that a required parameter is missing.
HTTP Status Code: 400ServiceUnavailableException
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
Data TypesThe following data types are supported:
• BackupJob (p. 185)• BackupPlan (p. 188)• BackupPlanInput (p. 189)• BackupPlansListMember (p. 190)• BackupPlanTemplatesListMember (p. 192)• BackupRule (p. 193)• BackupRuleInput (p. 195)• BackupSelection (p. 197)• BackupSelectionsListMember (p. 198)• BackupVaultListMember (p. 200)• CalculatedLifecycle (p. 202)• Condition (p. 203)• CopyAction (p. 204)• CopyJob (p. 205)• Lifecycle (p. 208)• ProtectedResource (p. 209)• RecoveryPointByBackupVault (p. 210)• RecoveryPointByResource (p. 213)• RecoveryPointCreator (p. 215)
183
AWS Backup 開発者ガイドData Types
• RestoreJobsListMember (p. 216)
184
AWS Backup 開発者ガイドBackupJob
BackupJobContains detailed information about a backup job.
ContentsBackupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
Required: NoBackupSizeInBytes
The size, in bytes, of a backup.
Type: Long
Required: NoBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: NoBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoBytesTransferred
The size in bytes transferred to a backup vault at the time that the job status was queried.
Type: Long
Required: NoCompletionDate
The date and time a job to create a backup job is completed, in Unix format and Coordinated UniversalTime (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatedBy
Contains identifying information about the creation of a backup job, including the BackupPlanArn,BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
185
AWS Backup 開発者ガイドBackupJob
Type: RecoveryPointCreator (p. 215) object
Required: NoCreationDate
The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoExpectedCompletionDate
The date and time a job to back up resources is expected to be completed, in Unix format andCoordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate tomilliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
Type: Timestamp
Required: NoIamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: NoPercentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
Type: String
Required: NoRecoveryPointArn
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: NoResourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: NoResourceType
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (AmazonEBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
186
AWS Backup 開発者ガイドBackupJob
Required: NoStartBy
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must bestarted before it is canceled. The value is calculated by adding the start window to the scheduled time.So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoState
The current state of a resource recovery point.
Type: String
Valid Values: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED |FAILED | EXPIRED
Required: NoStatusMessage
A detailed message explaining the status of the job to back up a resource.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
187
AWS Backup 開発者ガイドBackupPlan
BackupPlanContains an optional backup plan display name and an array of BackupRule objects, each of whichspecifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up adifferent selection of AWS resources.
ContentsBackupPlanName
The display name of a backup plan.
Type: String
Required: YesRules
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up aselection of resources.
Type: Array of BackupRule (p. 193) objects
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
188
AWS Backup 開発者ガイドBackupPlanInput
BackupPlanInputContains an optional backup plan display name and an array of BackupRule objects, each of whichspecifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up adifferent selection of AWS resources.
ContentsBackupPlanName
The display name of a backup plan.
Type: String
Required: YesRules
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up aselection of resources.
Type: Array of BackupRuleInput (p. 195) objects
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
189
AWS Backup 開発者ガイドBackupPlansListMember
BackupPlansListMemberContains metadata about a backup plan.
ContentsBackupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: String
Required: NoBackupPlanId
Uniquely identifies a backup plan.
Type: String
Required: NoBackupPlanName
The display name of a saved backup plan.
Type: String
Required: NoCreationDate
The date and time a resource backup plan is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: String
Required: NoDeletionDate
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoLastExecutionDate
The last time a job to back up resources was executed with this rule. A date and time, in Unixformat and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate
190
AWS Backup 開発者ガイドBackupPlansListMember
to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
Type: Timestamp
Required: NoVersionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Version IDs cannot be edited.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
191
AWS Backup 開発者ガイドBackupPlanTemplatesListMember
BackupPlanTemplatesListMemberAn object specifying metadata associated with a backup plan template.
ContentsBackupPlanTemplateId
Uniquely identifies a stored backup plan template.
Type: String
Required: NoBackupPlanTemplateName
The optional display name of a backup plan template.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
192
AWS Backup 開発者ガイドBackupRule
BackupRuleSpecifies a scheduled task used to back up a selection of resources.
ContentsCompletionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed or it will becanceled by AWS Backup. This value is optional.
Type: Long
Required: NoCopyActions
An array of CopyAction objects, which contains the details of the copy operation.
Type: Array of CopyAction (p. 204) objects
Required: NoLifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) object
Required: NoRecoveryPointTags
An array of key-value pair strings that are assigned to resources that are associated with this rule whenrestored from backup.
Type: String to string map
Required: NoRuleId
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
Type: String
Required: NoRuleName
An optional display name for a backup rule.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: Yes
193
AWS Backup 開発者ガイドBackupRule
ScheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
Type: String
Required: NoStartWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't startsuccessfully. This value is optional.
Type: Long
Required: NoTargetBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
194
AWS Backup 開発者ガイドBackupRuleInput
BackupRuleInputSpecifies a scheduled task used to back up a selection of resources.
ContentsCompletionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed or it will becanceled by AWS Backup. This value is optional.
Type: Long
Required: NoCopyActions
An array of CopyAction objects, which contains the details of the copy operation.
Type: Array of CopyAction (p. 204) objects
Required: NoLifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) object
Required: NoRecoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create.Each tag is a key-value pair.
Type: String to string map
Required: NoRuleName
An optional display name for a backup rule.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: YesScheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
Type: String
Required: No
195
AWS Backup 開発者ガイドBackupRuleInput
StartWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't startsuccessfully. This value is optional.
Type: Long
Required: NoTargetBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
196
AWS Backup 開発者ガイドBackupSelection
BackupSelectionUsed to specify a set of resources to a backup plan.
ContentsIamRoleArn
The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; forexample, arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: YesListOfTags
An array of conditions used to specify a set of resources to assign to a backup plan; for example,"STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting".
Type: Array of Condition (p. 203) objects
Required: NoResources
An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backupplan.
Type: Array of strings
Required: NoSelectionName
The display name of a resource selection document.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
197
AWS Backup 開発者ガイドBackupSelectionsListMember
BackupSelectionsListMemberContains metadata about a BackupSelection object.
ContentsBackupPlanId
Uniquely identifies a backup plan.
Type: String
Required: NoCreationDate
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: String
Required: NoIamRoleArn
Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: NoSelectionId
Uniquely identifies a request to assign a set of resources to a backup plan.
Type: String
Required: NoSelectionName
The display name of a resource selection document.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
198
AWS Backup 開発者ガイドBackupSelectionsListMember
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
199
AWS Backup 開発者ガイドBackupVaultListMember
BackupVaultListMemberContains metadata about a backup vault.
ContentsBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: NoBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoCreationDate
The date and time a resource backup is created, in Unix format and Coordinated UniversalTime (UTC). The value of CreationDate is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk ofexecuting the operation twice.
Type: String
Required: NoEncryptionKeyArn
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Type: String
Required: NoNumberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
Type: Long
Required: No
200
AWS Backup 開発者ガイドBackupVaultListMember
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
201
AWS Backup 開発者ガイドCalculatedLifecycle
CalculatedLifecycleContains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for arecovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWSBackup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore,the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The“transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
ContentsDeleteAt
A timestamp that specifies when to delete a recovery point.
Type: Timestamp
Required: NoMoveToColdStorageAt
A timestamp that specifies when to transition a recovery point to cold storage.
Type: Timestamp
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
202
AWS Backup 開発者ガイドCondition
ConditionContains an array of triplets made up of a condition type (such as STRINGEQUALS), a key, and a value.Conditions are used to filter resources in a selection that is assigned to a backup plan.
ContentsConditionKey
The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting","ec2:ResourceTag/Department" is the key.
Type: String
Required: YesConditionType
An operation, such as STRINGEQUALS, that is applied to a key-value pair used to filter resources in aselection.
Type: String
Valid Values: STRINGEQUALS
Required: YesConditionValue
The value in a key-value pair. For example, in "ec2:ResourceTag/Department":"accounting", "accounting" is the value.
Type: String
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
203
AWS Backup 開発者ガイドCopyAction
CopyActionThe details of the copy operation.
ContentsDestinationBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copiedbackup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: YesLifecycle
Contains an array of Transition objects specifying how long in days before a recovery pointtransitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transitionto cold after days” setting. The “transition to cold after days” setting cannot be changed after a backuphas been transitioned to cold.
Type: Lifecycle (p. 208) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
204
AWS Backup 開発者ガイドCopyJob
CopyJobContains detailed information about a copy job.
ContentsBackupSizeInBytes
The size, in bytes, of a copy job.
Type: Long
Required: NoCompletionDate
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC).The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCopyJobId
Uniquely identifies a copy job.
Type: String
Required: NoCreatedBy
Contains information about the backup plan and rule that AWS Backup used to initiate the recoverypoint backup.
Type: RecoveryPointCreator (p. 215) object
Required: NoCreationDate
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). Thevalue of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 representsFriday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoDestinationBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: NoDestinationRecoveryPointArn
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
205
AWS Backup 開発者ガイドCopyJob
Type: String
Required: NoIamRoleArn
Specifies the IAM role ARN used to copy the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: NoResourceArn
The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volumeor an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Required: NoResourceType
The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS)volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoSourceBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: NoSourceRecoveryPointArn
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: NoState
The current state of a copy job.
Type: String
Valid Values: CREATED | RUNNING | COMPLETED | FAILED
Required: NoStatusMessage
A detailed message explaining the status of the job to copy a resource.
Type: String
206
AWS Backup 開発者ガイドCopyJob
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
207
AWS Backup 開発者ガイドLifecycle
LifecycleContains an array of Transition objects specifying how long in days before a recovery point transitions tocold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore,on the console, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
ContentsDeleteAfterDays
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90days plus MoveToColdStorageAfterDays.
Type: Long
Required: NoMoveToColdStorageAfterDays
Specifies the number of days after creation that a recovery point is moved to cold storage.
Type: Long
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
208
AWS Backup 開発者ガイドProtectedResource
ProtectedResourceA structure that contains information about a backed-up resource.
ContentsLastBackupTime
The date and time a resource was last backed up, in Unix format and Coordinated UniversalTime (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoResourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN dependson the resource type.
Type: String
Required: NoResourceType
The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or anAmazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
209
AWS Backup 開発者ガイドRecoveryPointByBackupVault
RecoveryPointByBackupVaultContains detailed information about the recovery points stored in a backup vault.
ContentsBackupSizeInBytes
The size, in bytes, of a backup.
Type: Long
Required: NoBackupVaultArn
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Type: String
Required: NoBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoCalculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Type: CalculatedLifecycle (p. 202) object
Required: NoCompletionDate
The date and time a job to restore a recovery point is completed, in Unix format and CoordinatedUniversal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatedBy
Contains identifying information about the creation of a recovery point, including the BackupPlanArn,BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to createit.
Type: RecoveryPointCreator (p. 215) object
Required: No
210
AWS Backup 開発者ガイドRecoveryPointByBackupVault
CreationDate
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoEncryptionKeyArn
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Type: String
Required: NoIamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: NoIsEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if therecovery point is not encrypted.
Type: Boolean
Required: NoLastRestoreTime
The date and time a recovery point was last restored, in Unix format and Coordinated UniversalTime (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoLifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold afterdays” setting. The “transition to cold after days” setting cannot be changed after a backup has beentransitioned to cold.
Type: Lifecycle (p. 208) object
Required: NoRecoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
211
AWS Backup 開発者ガイドRecoveryPointByBackupVault
Type: String
Required: NoResourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: NoResourceType
The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store(Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoStatus
A status code specifying the state of the recovery point.
Type: String
Valid Values: COMPLETED | PARTIAL | DELETING | EXPIRED
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
212
AWS Backup 開発者ガイドRecoveryPointByResource
RecoveryPointByResourceContains detailed information about a saved recovery point.
ContentsBackupSizeBytes
The size, in bytes, of a backup.
Type: Long
Required: NoBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names thatare unique to the account used to create them and the AWS Region where they are created. Theyconsist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$
Required: NoCreationDate
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoEncryptionKeyArn
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Type: String
Required: NoRecoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: NoStatus
A status code specifying the state of the recovery point.
Type: String
Valid Values: COMPLETED | PARTIAL | DELETING | EXPIRED
Required: No
213
AWS Backup 開発者ガイドRecoveryPointByResource
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
214
AWS Backup 開発者ガイドRecoveryPointCreator
RecoveryPointCreatorContains information about the backup plan and rule that AWS Backup used to initiate the recovery pointbackup.
ContentsBackupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Type: String
Required: NoBackupPlanId
Uniquely identifies a backup plan.
Type: String
Required: NoBackupPlanVersion
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024bytes long. They cannot be edited.
Type: String
Required: NoBackupRuleId
Uniquely identifies a rule used to schedule the backup of a selection of resources.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
215
AWS Backup 開発者ガイドRestoreJobsListMember
RestoreJobsListMemberContains metadata about a restore job.
ContentsBackupSizeInBytes
The size, in bytes, of the restored resource.
Type: Long
Required: NoCompletionDate
The date and time a job to restore a recovery point is completed, in Unix format and CoordinatedUniversal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, thevalue 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoCreatedResourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN dependson the resource type.
Type: String
Required: NoCreationDate
The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC).The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: NoExpectedCompletionTimeMinutes
The amount of time in minutes that a job restoring a recovery point is expected to take.
Type: Long
Required: NoIamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.
Type: String
Required: NoPercentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
216
AWS Backup 開発者ガイドCommon Errors
Type: String
Required: NoRecoveryPointArn
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: NoRestoreJobId
Uniquely identifies the job that restores a recovery point.
Type: String
Required: NoStatus
A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.
Type: String
Valid Values: PENDING | RUNNING | COMPLETED | ABORTED | FAILED
Required: NoStatusMessage
A detailed message explaining the status of the job to restore a recovery point.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400
217
AWS Backup 開発者ガイドCommon Errors
IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
218
AWS Backup 開発者ガイドCommon Errors
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp onthe request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
219
AWS Backup 開発者ガイド
AWS の用語集最新の AWS の用語については、『AWS General Reference』の「AWS の用語集」を参照してください。
220
AWS Backup 開発者ガイド
AWS Backup のドキュメント履歴以下の表は、今回のリリースの AWS Backup に関するドキュメントの説明です。
• API バージョン: 2019-01-15• ドキュメントの最終更新日: 2019 年 1 月 15 日
変更 説明 更新日
新規ガイド これは AWS Backup 開発者ガイドの最初のリリースです。
2019 年 1 月 15 日
221