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

Interface CfnScheduledReportPropsMixin.ScheduleConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledReportPropsMixin.ScheduleConfigProperty.Jsii$Proxy

Enclosing class:

CfnScheduledReportPropsMixin

@Stability(Stable)
public static interface CfnScheduledReportPropsMixin.ScheduleConfigProperty
extends software.amazon.jsii.JsiiSerializable

Defines when and how often a scheduled report runs.

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.*;
 ScheduleConfigProperty scheduleConfigProperty = ScheduleConfigProperty.builder()
         .scheduleExpression("scheduleExpression")
         .scheduleExpressionTimeZone("scheduleExpressionTimeZone")
         .schedulePeriod(SchedulePeriodProperty.builder()
                 .endTime("endTime")
                 .startTime("startTime")
                 .build())
         .state("state")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledReportPropsMixin.ScheduleConfigProperty.Builder	builder()
default String	getScheduleExpression()	The schedule expression that specifies when to trigger the scheduled report run.
default String	getScheduleExpressionTimeZone()	The time zone for the schedule expression, for example, UTC.
default Object	getSchedulePeriod()	The window during which the schedule is active.
default String	getState()	Whether the schedule is active.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScheduleExpression

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

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

getScheduleExpressionTimeZone

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

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

getSchedulePeriod

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

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.

Returns union: either IResolvable or CfnScheduledReportPropsMixin.SchedulePeriodProperty

See Also:

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

getState

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

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

builder

@Stability(Stable)
static CfnScheduledReportPropsMixin.ScheduleConfigProperty.Builder builder()

Returns:

a CfnScheduledReportPropsMixin.ScheduleConfigProperty.Builder of CfnScheduledReportPropsMixin.ScheduleConfigProperty