AWS::Backup::ReportPlan - AWS CloudFormation

AWS::Backup::ReportPlan

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 AWS CloudFormation template, see the AWS Backup Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Backup::ReportPlan", "Properties" : { "ReportDeliveryChannel" : Json, "ReportPlanDescription" : String, "ReportPlanName" : String, "ReportPlanTags" : [ Tag, ... ], "ReportSetting" : Json } }

YAML

Type: AWS::Backup::ReportPlan Properties: ReportDeliveryChannel: Json ReportPlanDescription: String ReportPlanName: String ReportPlanTags: - Tag ReportSetting: Json

Properties

ReportDeliveryChannel

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.

Required: Yes

Type: Json

Update requires: No interruption

ReportPlanDescription

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

Required: No

Type: String

Minimum: 0

Maximum: 1024

Pattern: .*\S.*

Update requires: No interruption

ReportPlanName

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 (_).

Required: No

Type: String

Minimum: 1

Maximum: 256

Pattern: [a-zA-Z][_a-zA-Z0-9]*

Update requires: Replacement

ReportPlanTags

A list of tags to tag your report plan.

Required: No

Type: List of Tag

Update requires: No interruption

ReportSetting

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.

Required: Yes

Type: Json

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ReportPlanArn

The Amazon Resource Name (ARN) of your report plan.