AWS::Backup::ReportPlan - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Backup::ReportPlan

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Amazon Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

For a sample Amazon CloudFormation template, see the Amazon Backup Developer Guide.

Syntax

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

JSON

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

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: ReportDeliveryChannel

Update requires: No interruption

ReportPlanDescription

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

Required: No

Type: String

Pattern: .*\S.*

Minimum: 0

Maximum: 1024

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

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

Minimum: 1

Maximum: 256

Update requires: Replacement

ReportPlanTags

The tags to assign to your report plan.

Required: No

Type: Array 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 Amazon Web Services Regions and frameworks.

Required: Yes

Type: ReportSetting

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ReportPlanArn

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