CfnScheduledReportMixinProps

class aws_cdk.cfn_property_mixins.aws_bcm.CfnScheduledReportMixinProps(*, dashboard_arn=None, description=None, name=None, schedule_config=None, scheduled_report_execution_role_arn=None, tags=None, widget_date_range_override=None, widget_ids=None)

Bases: object

Properties for CfnScheduledReportPropsMixin.

Parameters:

dashboard_arn (Optional[str]) – The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
description (Optional[str]) – A description of the scheduled report’s purpose or contents.
name (Optional[str]) – The name of the scheduled report.
schedule_config (Union[IResolvable, ScheduleConfigProperty, Dict[str, Any], None]) – Defines when and how often a scheduled report runs.
scheduled_report_execution_role_arn (Optional[str]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags applied to the scheduled report.
widget_date_range_override (Union[IResolvable, DateTimeRangeProperty, Dict[str, Any], None]) – An absolute or relative date range.
widget_ids (Optional[Sequence[str]]) – The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_bcm as bcm

cfn_scheduled_report_mixin_props = bcm.CfnScheduledReportMixinProps(
    dashboard_arn="dashboardArn",
    description="description",
    name="name",
    schedule_config=bcm.CfnScheduledReportPropsMixin.ScheduleConfigProperty(
        schedule_expression="scheduleExpression",
        schedule_expression_time_zone="scheduleExpressionTimeZone",
        schedule_period=bcm.CfnScheduledReportPropsMixin.SchedulePeriodProperty(
            end_time="endTime",
            start_time="startTime"
        ),
        state="state"
    ),
    scheduled_report_execution_role_arn="scheduledReportExecutionRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    widget_date_range_override=bcm.CfnScheduledReportPropsMixin.DateTimeRangeProperty(
        end_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
            type="type",
            value="value"
        ),
        start_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
            type="type",
            value="value"
        )
    ),
    widget_ids=["widgetIds"]
)