interface CfnReportPlanProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Backup.CfnReportPlanProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#CfnReportPlanProps |
![]() | software.amazon.awscdk.services.backup.CfnReportPlanProps |
![]() | aws_cdk.aws_backup.CfnReportPlanProps |
![]() | aws-cdk-lib » aws_backup » CfnReportPlanProps |
Properties for defining a CfnReportPlan
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';
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
Name | Type | Description |
---|---|---|
report | 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. |
report | any | Identifies the report template for the report. Reports are built using a report template. The report templates are:. |
report | string | An optional description of the report plan with a maximum 1,024 characters. |
report | string | The unique name of the report plan. |
report | Cfn [] | The tags to assign to 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:
Cfn
[]
(optional)
The tags to assign to your report plan.