Skip to content

Resource: awsBackupReportPlan

Provides an AWS Backup Report Plan resource.

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.backupReportPlan.BackupReportPlan(this, "example", {
  description: "example description",
  name: "example_name",
  reportDeliveryChannel: {
    formats: ["CSV", "JSON"],
    s3BucketName: "example-bucket-name",
  },
  reportSetting: {
    reportTemplate: "RESTORE_JOB_REPORT",
  },
  tags: {
    Name: "Example Report Plan",
  },
});

Argument Reference

The following arguments are supported:

  • description - (Optional) The description of the report plan with a maximum of 1,024 characters
  • name - (Required) The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
  • reportDeliveryChannel - (Required) 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 - (Required) An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
  • tags - (Optional) Metadata that you can assign to help organize the report plans you create. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Report Delivery Channel Arguments

For report_delivery_channel the following attributes are supported:

  • formats - (Optional) A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
  • s3BucketName - (Required) The unique name of the S3 bucket that receives your reports.
  • s3KeyPrefix - (Optional) The 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. If not specified, there is no prefix.

Report Setting Arguments

For report_setting the following attributes are supported:

  • frameworkArns - (Optional) Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
  • numberOfFrameworks - (Optional) Specifies the number of frameworks a report covers.
  • reportTemplate - (Required) Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.

Attributes Reference

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

  • arn - The ARN of the backup report plan.
  • creationTime - The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
  • deploymentStatus - The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | completed.
  • id - The id of the backup report plan.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

Backup Report Plan can be imported using the id which corresponds to the name of the Backup Report Plan, e.g.,

$ terraform import aws_backup_report_plan.test <id>