AWS Backup API を使用したレポートプランの作成

レポート計画は、プログラムで操作することもできます。

レポートには 2 つのタイプがあります。1 つ目のタイプは、ジョブレポートで、過去 24 時間以内に完了したジョブとすべてのアクティブなジョブが表示されます。2 つ目のタイプのレポートはコンプライアンスレポートです。コンプライアンスレポートでは、リソースレベルや実施されているさまざまなコントロールをモニタリングできます。レポートを作成するときは、作成するレポートのタイプを選択します。

バックアッププランと同様に、レポートプランを作成し、レポートの作成を自動化して、送信先の Amazon S3 バケットを定義します。レポートプランでは、レポートを受け取る S3 バケットが必要です。新しい S3 バケットを設定する手順については、Amazon Simple Storage Service ユーザーガイドのステップ 1: 最初の S3 バケットを作成するを参照してください。

カスタム KMS キーを使用してバケットを暗号化する場合、KMS キーポリシーは次の要件を満たしている必要があります。

AWSServiceRolePolicyForBackupReports ポリシーには、これらのアクセス許可があります。

単一アカウント、単一リージョンのレポートの場合は、次の構文を使用して CreateReportPlan を呼び出します。

{
   "ReportPlanName": "string",
   "ReportPlanDescription": "string",
   "ReportSetting": {
        "ReportTemplate": enum, // Can be RESOURCE_COMPLIANCE_REPORT, CONTROL_COMPLIANCE_REPORT, BACKUP_JOB_REPORT, COPY_JOB_REPORT, or RESTORE_JOB_REPORT. Only include "ReportCoverageList" if your report is a COMPLIANCE_REPORT.
   "ReportDeliveryChannel": {
       "S3BucketName": "string",
       "S3KeyPrefix": "string",
       "Formats": [ enum ] // Optional. Can be either CSV, JSON, or both. Default is CSV if left blank.
   },
   "ReportPlanTags": { 
       "string" : "string" // Optional.
   },
   "IdempotencyToken": "string"
}

DescribeReportPlanレポートプランの一意の名前で電話すると、 AWS Backup API は以下の情報を応答します。

{
    "ReportPlanArn": "string",
    "ReportPlanName": "string",
    "ReportPlanDescription": "string",
    "ReportSetting": {
        "ReportTemplate": enum,
    },
    "ReportDeliveryChannel": {
        "S3BucketName": "string",
        "S3KeyPrefix": "string",
        "Formats": [ enum ]
    },
    "DeploymentStatus": enum
    "CreationTime": timestamp,
    "LastAttemptExecutionTime": timestamp,
    "LastSuccessfulExecutionTime": timestamp
}

マルチアカウント、マルチリージョンのレポートでは、次の構文を使用して CreateReportPlan を呼び出します。

{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ], *//Organization report only support CSV file*
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportPlanName": "string",
   "ReportPlanTags": { 
      "string" : "string" 
   },
   "ReportSetting": { 
      "Accounts": [ "string" ], // Use string value of "ROOT" to include all organizational units
      "OrganizationUnits": [ "string" ],
      "Regions": ["string"], // Use wildcard value in string to include all Regions
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "ReportTemplate": "string"
   }
}

レポートプランの一意の名前で DescribeReportPlan を呼び出すと、 AWS Backup API は、マルチアカウント、マルチリージョンのプランに関して、以下の情報を応答します。

{
   "ReportPlan": { 
      "CreationTime": number,
      "DeploymentStatus": "string",
      "LastAttemptedExecutionTime": number,
      "LastSuccessfulExecutionTime": number,
      "ReportDeliveryChannel": { 
         "Formats": [ "string" ],
         "S3BucketName": "string",
         "S3KeyPrefix": "string"
      },
      "ReportPlanArn": "string",
      "ReportPlanDescription": "string",
      "ReportPlanName": "string",
      "ReportSetting": { 
         "Accounts":[ "string" ],
         "OrganizationUnits":[ "string" ],
         "Regions": [ "string" ], 
         "FrameworkArns": [ "string" ],
         "NumberOfFrameworks": number,
         "ReportTemplate": "string"
      }
   }
}