1.204.0

interface CfnReportPlanProps

LanguageType name
.NETAmazon.CDK.AWS.Backup.CfnReportPlanProps
Javasoftware.amazon.awscdk.services.backup.CfnReportPlanProps
Pythonaws_cdk.aws_backup.CfnReportPlanProps
TypeScript @aws-cdk/aws-backup » CfnReportPlanProps

Properties for defining a CfnReportPlan.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as backup from '@aws-cdk/aws-backup';

declare const reportDeliveryChannel: any;
declare const reportSetting: any;
const cfnReportPlanProps: backup.CfnReportPlanProps = {
  reportDeliveryChannel: reportDeliveryChannel,
  reportSetting: reportSetting,

  // the properties below are optional
  reportPlanDescription: 'reportPlanDescription',
  reportPlanName: 'reportPlanName',
  reportPlanTags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
reportDeliveryChannelanyContains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
reportSettinganyIdentifies the report template for the report. Reports are built using a report template. The report templates are:.
reportPlanDescription?stringAn optional description of the report plan with a maximum 1,024 characters.
reportPlanName?stringThe unique name of the report plan.
reportPlanTags?IResolvable | IResolvable | CfnTag[]A list of tags to tag your report plan.

reportDeliveryChannel

Type: 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.

reportSetting

Type: 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.

reportPlanDescription?

Type: string (optional)

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

reportPlanName?

Type: string (optional)

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

reportPlanTags?

Type: IResolvable | IResolvable | CfnTag[] (optional)

A list of tags to tag your report plan.

← PreviousNext →