interface CfnScheduledReportMixinProps

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.BCM.CfnScheduledReportMixinProps
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsbcm#CfnScheduledReportMixinProps
Java	software.amazon.awscdk.cfnpropertymixins.services.bcm.CfnScheduledReportMixinProps
Python	aws_cdk.cfn_property_mixins.aws_bcm.CfnScheduledReportMixinProps
TypeScript	@aws-cdk/cfn-property-mixins » aws_bcm » CfnScheduledReportMixinProps

Properties for CfnScheduledReportPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bcm as bcm } from '@aws-cdk/cfn-property-mixins';
const cfnScheduledReportMixinProps: bcm.CfnScheduledReportMixinProps = {
  dashboardArn: 'dashboardArn',
  description: 'description',
  name: 'name',
  scheduleConfig: {
    scheduleExpression: 'scheduleExpression',
    scheduleExpressionTimeZone: 'scheduleExpressionTimeZone',
    schedulePeriod: {
      endTime: 'endTime',
      startTime: 'startTime',
    },
    state: 'state',
  },
  scheduledReportExecutionRoleArn: 'scheduledReportExecutionRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  widgetDateRangeOverride: {
    endTime: {
      type: 'type',
      value: 'value',
    },
    startTime: {
      type: 'type',
      value: 'value',
    },
  },
  widgetIds: ['widgetIds'],
};

Properties

Name	Type	Description
dashboardArn?	string	The ARN of the dashboard associated with the scheduled report.
description?	string	A description of the scheduled report's purpose or contents.
name?	string	The name of the scheduled report.
scheduleConfig?	IResolvable | ScheduleConfigProperty	Defines when and how often a scheduled report runs.
scheduledReportExecutionRoleArn?	string	The ARN of the IAM role that the scheduled report uses to execute.
tags?	CfnTag[]	The tags applied to the scheduled report.
widgetDateRangeOverride?	IResolvable | DateTimeRangeProperty	An absolute or relative date range.
widgetIds?	string[]	The list of widget identifiers included in the scheduled report.

---

dashboardArn?

Type: string (optional)

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

---

description?

Type: string (optional)

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

---

name?

Type: string (optional)

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

---

scheduleConfig?

Type: IResolvable | ScheduleConfigProperty (optional)

Defines when and how often a scheduled report runs.

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

---

scheduledReportExecutionRoleArn?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

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

---

widgetDateRangeOverride?

Type: IResolvable | DateTimeRangeProperty (optional)

An absolute or relative date range.

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

---

widgetIds?

Type: string[] (optional)

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