Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-backup-reportplan.json
Parent schema serverless-framework-configuration
Type: object

Contains detailed information about a report plan in AWS Backup Audit Manager.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ReportDeliveryChannel object required

A structure 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.

3 nested properties
S3BucketName string | Aws_CF_FunctionString required

The unique name of the S3 bucket that receives your reports.

Formats string[]

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

uniqueItems=true
S3KeyPrefix string | Aws_CF_FunctionString

The prefix for where AWS 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.

ReportSetting object required

Identifies the report template for the report. Reports are built using a report template.

5 nested properties
ReportTemplate string | Aws_CF_FunctionString required

Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

FrameworkArns string[]

The Amazon Resource Names (ARNs) of the frameworks a report covers.

uniqueItems=true
Accounts string[]

The list of AWS accounts that a report covers.

uniqueItems=true
OrganizationUnits string[]

The list of AWS organization units that a report covers.

uniqueItems=true
Regions string[]

The list of AWS regions that a report covers.

uniqueItems=true
ReportPlanName string | Aws_CF_FunctionString

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

ReportPlanDescription string | Aws_CF_FunctionString

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

ReportPlanTags Tag[]

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.