AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Backup::ReportPlan

CfnReportPlan

Creates a report plan. A report plan is a document that contains information about the contents of the report and where AWS Backup will deliver it. If you call `CreateReportPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception. For a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn) .

Import

import { CfnReportPlan } from 'aws-cdk-lib/aws-backup';

Or use the module namespace:

import * as backup from 'aws-cdk-lib/aws-backup';
// backup.CfnReportPlan

Properties

Configuration passed to the constructor as CfnReportPlanProps.

reportDeliveryChannelRequired
any

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.

reportSettingRequired
any

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` If the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT` , this API resource also describes the report coverage by AWS Regions and frameworks.

reportPlanDescriptionOptional
string

An optional description of the report plan with a maximum 1,024 characters.

reportPlanNameOptional
string

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

reportPlanTagsOptional
CfnTag[]

The tags to assign to your report plan.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter