Package software.amazon.awscdk.cfnpropertymixins.services.backup

Interface CfnReportPlanMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReportPlanMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.289Z")
@Stability(Stable)
public interface CfnReportPlanMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnReportPlanPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.backup.*;
 Object reportDeliveryChannel;
 Object reportSetting;
 CfnReportPlanMixinProps cfnReportPlanMixinProps = CfnReportPlanMixinProps.builder()
         .reportDeliveryChannel(reportDeliveryChannel)
         .reportPlanDescription("reportPlanDescription")
         .reportPlanName("reportPlanName")
         .reportPlanTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .reportSetting(reportSetting)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReportPlanMixinProps.Builder	A builder for CfnReportPlanMixinProps
static final class	CfnReportPlanMixinProps.Jsii$Proxy	An implementation for CfnReportPlanMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnReportPlanMixinProps.Builder	builder()
default Object	getReportDeliveryChannel()	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.
default String	getReportPlanDescription()	An optional description of the report plan with a maximum 1,024 characters.
default String	getReportPlanName()	The unique name of the report plan.
default List<CfnTag>	getReportPlanTags()	The tags to assign to your report plan.
default Object	getReportSetting()	Identifies the report template for the report.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getReportDeliveryChannel

@Stability(Stable)
@Nullable
default Object getReportDeliveryChannel()

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.

See Also:

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

getReportPlanDescription

@Stability(Stable)
@Nullable
default String getReportPlanDescription()

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

See Also:

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

getReportPlanName

@Stability(Stable)
@Nullable
default String getReportPlanName()

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

See Also:

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

getReportPlanTags

@Stability(Stable)
@Nullable
default List<CfnTag> getReportPlanTags()

The tags to assign to your report plan.

See Also:

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

getReportSetting

@Stability(Stable)
@Nullable
default Object getReportSetting()

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.

See Also:

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

builder

@Stability(Stable)
static CfnReportPlanMixinProps.Builder builder()

Returns:

a CfnReportPlanMixinProps.Builder of CfnReportPlanMixinProps