scheduler/aws.sdk.kotlin.services.scheduler.model/CreateScheduleRequest/Builder

Builder

Properties

var actionAfterCompletion: ActionAfterCompletion?

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

clientToken

var clientToken: String?

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

description

var description: String?

The description you specify for the schedule.

endDate

var endDate: Instant?

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. EventBridge Scheduler ignores EndDate for one-time schedules.

flexibleTimeWindow

var flexibleTimeWindow: FlexibleTimeWindow?

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

groupName

var groupName: String?

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

kmsKeyArn

var kmsKeyArn: String?

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name

var name: String?

The name of the schedule that you are creating.

scheduleExpression

var scheduleExpression: String?

The expression that defines when the schedule runs. The following formats are supported.

scheduleExpressionTimezone

var scheduleExpressionTimezone: String?

The timezone in which the scheduling expression is evaluated.

startDate

var startDate: Instant?

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. EventBridge Scheduler ignores StartDate for one-time schedules.

state

var state: ScheduleState?

Specifies whether the schedule is enabled or disabled.

target

var target: Target?

The schedule's target.

Functions

flexibleTimeWindow

fun flexibleTimeWindow(block: FlexibleTimeWindow.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.scheduler.model.FlexibleTimeWindow inside the given block

target

fun target(block: Target.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.scheduler.model.Target inside the given block