interface ScheduleConfigProperty

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

Defines when and how often a scheduled report runs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.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 scheduleConfigProperty: bcm.CfnScheduledReportPropsMixin.ScheduleConfigProperty = {
  scheduleExpression: 'scheduleExpression',
  scheduleExpressionTimeZone: 'scheduleExpressionTimeZone',
  schedulePeriod: {
    endTime: 'endTime',
    startTime: 'startTime',
  },
  state: 'state',
};

Properties

Name	Type	Description
scheduleExpression?	string	The schedule expression that specifies when to trigger the scheduled report run.
scheduleExpressionTimeZone?	string	The time zone for the schedule expression, for example, UTC.
schedulePeriod?	IResolvable | SchedulePeriodProperty	The window during which the schedule is active.
state?	string	Whether the schedule is active.

---

scheduleExpression?

Type: string (optional)

The schedule expression that specifies when to trigger the scheduled report run.

This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).

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

---

scheduleExpressionTimeZone?

Type: string (optional)

The time zone for the schedule expression, for example, UTC.

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

---

schedulePeriod?

Type: IResolvable | SchedulePeriodProperty (optional)

The window during which the schedule is active.

When omitted the service defaults it. EndTime must be within three years of the time of the request.

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

---

state?

Type: string (optional)

Whether the schedule is active.

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