Package software.amazon.awscdk.services.backup

Interface CfnReportPlan.ReportSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReportPlan.ReportSettingProperty.Jsii$Proxy

Enclosing class:

CfnReportPlan

@Stability(Stable)
public static interface CfnReportPlan.ReportSettingProperty
extends software.amazon.jsii.JsiiSerializable

Contains detailed information about a report setting.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 ReportSettingProperty reportSettingProperty = ReportSettingProperty.builder()
         .reportTemplate("reportTemplate")
         // the properties below are optional
         .accounts(List.of("accounts"))
         .frameworkArns(List.of("frameworkArns"))
         .organizationUnits(List.of("organizationUnits"))
         .regions(List.of("regions"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReportPlan.ReportSettingProperty.Builder	builder()
default List<String>	getAccounts()	These are the accounts to be included in the report.
default List<String>	getFrameworkArns()	The Amazon Resource Names (ARNs) of the frameworks a report covers.
default List<String>	getOrganizationUnits()	These are the Organizational Units to be included in the report.
default List<String>	getRegions()	These are the Regions to be included in the report.
String	getReportTemplate()	Identifies the report template for the report.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getReportTemplate

@Stability(Stable)
@NotNull
String getReportTemplate()

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

See Also:

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

getAccounts

@Stability(Stable)
@Nullable
default List<String> getAccounts()

These are the accounts to be included in the report.

Use string value of ROOT to include all organizational units.

See Also:

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

getFrameworkArns

@Stability(Stable)
@Nullable
default List<String> getFrameworkArns()

The Amazon Resource Names (ARNs) of the frameworks a report covers.

See Also:

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

getOrganizationUnits

@Stability(Stable)
@Nullable
default List<String> getOrganizationUnits()

These are the Organizational Units to be included in the report.

See Also:

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

getRegions

@Stability(Stable)
@Nullable
default List<String> getRegions()

These are the Regions to be included in the report.

Use the wildcard as the string value to include all Regions.

See Also:

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

builder

@Stability(Stable)
static CfnReportPlan.ReportSettingProperty.Builder builder()

Returns:

a CfnReportPlan.ReportSettingProperty.Builder of CfnReportPlan.ReportSettingProperty