Package software.amazon.awscdk.cfnpropertymixins.services.bcm

Interface CfnScheduledReportMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledReportMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:06.158Z")
@Stability(Stable)
public interface CfnScheduledReportMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnScheduledReportPropsMixin.

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.bcm.*;
 CfnScheduledReportMixinProps cfnScheduledReportMixinProps = CfnScheduledReportMixinProps.builder()
         .dashboardArn("dashboardArn")
         .description("description")
         .name("name")
         .scheduleConfig(ScheduleConfigProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .scheduleExpressionTimeZone("scheduleExpressionTimeZone")
                 .schedulePeriod(SchedulePeriodProperty.builder()
                         .endTime("endTime")
                         .startTime("startTime")
                         .build())
                 .state("state")
                 .build())
         .scheduledReportExecutionRoleArn("scheduledReportExecutionRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .widgetDateRangeOverride(DateTimeRangeProperty.builder()
                 .endTime(DateTimeValueProperty.builder()
                         .type("type")
                         .value("value")
                         .build())
                 .startTime(DateTimeValueProperty.builder()
                         .type("type")
                         .value("value")
                         .build())
                 .build())
         .widgetIds(List.of("widgetIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledReportMixinProps.Builder	builder()
default String	getDashboardArn()	The ARN of the dashboard associated with the scheduled report.
default String	getDescription()	A description of the scheduled report's purpose or contents.
default String	getName()	The name of the scheduled report.
default Object	getScheduleConfig()	Defines when and how often a scheduled report runs.
default String	getScheduledReportExecutionRoleArn()	The ARN of the IAM role that the scheduled report uses to execute.
default List<CfnTag>	getTags()	The tags applied to the scheduled report.
default Object	getWidgetDateRangeOverride()	An absolute or relative date range.
default List<String>	getWidgetIds()	The list of widget identifiers included in the scheduled report.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDashboardArn

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

The ARN of the dashboard associated with the scheduled report.

Managed dashboards cannot be used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-dashboardarn

getDescription

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

A description of the scheduled report's purpose or contents.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-description

getName

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

The name of the scheduled report.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-name

getScheduleConfig

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

Defines when and how often a scheduled report runs.

Returns union: either IResolvable or CfnScheduledReportPropsMixin.ScheduleConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-scheduleconfig

getScheduledReportExecutionRoleArn

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

The ARN of the IAM role that the scheduled report uses to execute.

AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-scheduledreportexecutionrolearn

getTags

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

The tags applied to the scheduled report.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-tags

getWidgetDateRangeOverride

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

An absolute or relative date range.

Returns union: either IResolvable or CfnScheduledReportPropsMixin.DateTimeRangeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-widgetdaterangeoverride

getWidgetIds

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

The list of widget identifiers included in the scheduled report.

If not specified, all widgets in the dashboard are included.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html#cfn-bcm-scheduledreport-widgetids

builder

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

Returns:

a CfnScheduledReportMixinProps.Builder of CfnScheduledReportMixinProps