ScheduleArgs

data class ScheduleArgs(val description: Output<String>? = null, val endDate: Output<String>? = null, val flexibleTimeWindow: Output<ScheduleFlexibleTimeWindowArgs>? = null, val groupName: Output<String>? = null, val kmsKeyArn: Output<String>? = null, val name: Output<String>? = null, val scheduleExpression: Output<String>? = null, val scheduleExpressionTimezone: Output<String>? = null, val startDate: Output<String>? = null, val state: Output<ScheduleState>? = null, val target: Output<ScheduleTargetArgs>? = null) : ConvertibleToJava<ScheduleArgs>

Definition of AWS::Scheduler::Schedule Resource Type

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, endDate: Output<String>? = null, flexibleTimeWindow: Output<ScheduleFlexibleTimeWindowArgs>? = null, groupName: Output<String>? = null, kmsKeyArn: Output<String>? = null, name: Output<String>? = null, scheduleExpression: Output<String>? = null, scheduleExpressionTimezone: Output<String>? = null, startDate: Output<String>? = null, state: Output<ScheduleState>? = null, target: Output<ScheduleTargetArgs>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

The description of the schedule.

Link copied to clipboard
val endDate: Output<String>? = null

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.

Link copied to clipboard

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

Link copied to clipboard
val groupName: Output<String>? = null

The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

Link copied to clipboard
val kmsKeyArn: Output<String>? = null

The ARN for a KMS Key that will be used to encrypt customer data.

Link copied to clipboard
val name: Output<String>? = null

The name of the schedule.

Link copied to clipboard
val scheduleExpression: Output<String>? = null

The scheduling expression.

Link copied to clipboard
val scheduleExpressionTimezone: Output<String>? = null

The timezone in which the scheduling expression is evaluated.

Link copied to clipboard
val startDate: Output<String>? = null

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify.

Link copied to clipboard
val state: Output<ScheduleState>? = null

Specifies whether the schedule is enabled or disabled. Allowed Values : ENABLED | DISABLED

Link copied to clipboard
val target: Output<ScheduleTargetArgs>? = null

The schedule's target details.

Functions

Link copied to clipboard
open override fun toJava(): ScheduleArgs