Skip to content

Data Source: awsBackupReportPlan

Use this data source to get information on an existing backup report plan.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsBackupReportPlan.DataAwsBackupReportPlan(this, "example", {
  name: "tf_example_backup_report_plan_name",
});

Argument Reference

The following arguments are supported:

  • name - (Required) Backup report plan name.

Attributes Reference

In addition to the arguments above, the following attributes are exported:

  • arn - ARN of the backup report plan.
  • creationTime - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
  • deploymentStatus - Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | completed.
  • description - Description of the report plan.
  • id - ID of the report plan.
  • reportDeliveryChannel - An object that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. Detailed below.
  • reportSetting - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
  • tags - Metadata that you can assign to help organize the report plans you create.

Report Delivery Channel Attributes

For report_delivery_channel the following attributes are supported:

  • formats - List of the format of your reports: CSV, JSON, or both.
  • s3BucketName - Unique name of the S3 bucket that receives your reports.
  • s3KeyPrefix - Prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.

Report Setting Attributes

For report_setting the following attributes are supported:

  • frameworkArns - ARNs of the frameworks a report covers.
  • numberOfFrameworks - Specifies the number of frameworks a report covers.
  • reportTemplate - Identifies the report template for the report. Reports are built using a report template.