Création de plans de rapports à l'aide de l' AWS Backup API

Vous pouvez également utiliser des plans de rapport par programmation.

Il existe deux types de rapports. L'un d'entre eux est un rapport sur les tâches, qui indique les tâches terminées au cours des dernières 24 heures et toutes les tâches actives. Le deuxième type de rapport est un rapport de conformité. Les rapports de conformité peuvent surveiller les niveaux de ressources ou les différents contrôles en vigueur. Lorsque vous créez un rapport, vous choisissez le type de rapport à créer.

À l'instar d'un plan de sauvegarde, vous créez un plan de rapport pour automatiser la création de vos rapports et définir leur compartiment Amazon S3 de destination. Un plan de rapport nécessite que vous disposiez d'un compartiment S3 pour recevoir vos rapports. Pour obtenir des instructions sur la configuration d'un nouveau compartiment S3, consultez Étape 1 : Créer votre premier compartiment S3 dans le Guide de l'utilisateur Amazon Simple Storage Service.

Si vous chiffrez votre compartiment à l'aide d'une clé KMS personnalisée, la politique de clé KMS doit répondre aux exigences suivantes :

La politique AWSServiceRolePolicyForBackupReportsdispose de ces autorisations.

Pour les rapports à compte unique ou à région unique, utilisez la syntaxe suivante pour appeler 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"
}

Lorsque vous appelez DescribeReportPlan avec le nom unique d'un plan de rapport, l'API AWS Backup répond avec les informations suivantes.

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

Pour les rapports à comptes multiples et régions multiples, utilisez la syntaxe suivante pour appeler 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"
   }
}

Lorsque vous appelez DescribeReportPlan avec le nom unique d'un plan de rapport, l'API AWS Backup répond avec les informations suivantes pour les plans à comptes multiples et régions multiples :

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