CfnReportPlanProps

class aws_cdk.aws_backup.CfnReportPlanProps(*, report_delivery_channel, report_setting, report_plan_description=None, report_plan_name=None, report_plan_tags=None)

Bases: object

Properties for defining a CfnReportPlan.

Parameters
  • report_delivery_channel (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_setting (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.

  • report_plan_description (Optional[str]) – An optional description of the report plan with a maximum 1,024 characters.

  • report_plan_name (Optional[str]) – 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 (_).

  • report_plan_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – A list of tags to tag your report plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_backup as backup

# report_delivery_channel: Any
# report_setting: Any

cfn_report_plan_props = backup.CfnReportPlanProps(
    report_delivery_channel=report_delivery_channel,
    report_setting=report_setting,

    # the properties below are optional
    report_plan_description="reportPlanDescription",
    report_plan_name="reportPlanName",
    report_plan_tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

report_delivery_channel

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportdeliverychannel

Return type

Any

report_plan_description

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplandescription

Return type

Optional[str]

report_plan_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplanname

Return type

Optional[str]

report_plan_tags

A list of tags to tag your report plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplantags

Return type

Union[IResolvable, List[Union[IResolvable, CfnTag]], None]

report_setting

.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportsetting

Type

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

Return type

Any