public static interface CreateScheduleRequest.Builder extends SchedulerRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateScheduleRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
|
CreateScheduleRequest.Builder |
description(String description)
The description you specify for the schedule.
|
CreateScheduleRequest.Builder |
endDate(Instant endDate)
The date, in UTC, before which the schedule can invoke its target.
|
default CreateScheduleRequest.Builder |
flexibleTimeWindow(Consumer<FlexibleTimeWindow.Builder> flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
CreateScheduleRequest.Builder |
flexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
CreateScheduleRequest.Builder |
groupName(String groupName)
The name of the schedule group to associate with this schedule.
|
CreateScheduleRequest.Builder |
kmsKeyArn(String kmsKeyArn)
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to
encrypt and decrypt your data.
|
CreateScheduleRequest.Builder |
name(String name)
The name of the schedule that you are creating.
|
CreateScheduleRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateScheduleRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateScheduleRequest.Builder |
scheduleExpression(String scheduleExpression)
The expression that defines when the schedule runs.
|
CreateScheduleRequest.Builder |
scheduleExpressionTimezone(String scheduleExpressionTimezone)
The timezone in which the scheduling expression is evaluated.
|
CreateScheduleRequest.Builder |
startDate(Instant startDate)
The date, in UTC, after which the schedule can begin invoking its target.
|
CreateScheduleRequest.Builder |
state(ScheduleState state)
Specifies whether the schedule is enabled or disabled.
|
CreateScheduleRequest.Builder |
state(String state)
Specifies whether the schedule is enabled or disabled.
|
default CreateScheduleRequest.Builder |
target(Consumer<Target.Builder> target)
The schedule's target.
|
CreateScheduleRequest.Builder |
target(Target target)
The schedule's target.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateScheduleRequest.Builder clientToken(String clientToken)
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.
clientToken - 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.CreateScheduleRequest.Builder description(String description)
The description you specify for the schedule.
description - The description you specify for the schedule.CreateScheduleRequest.Builder endDate(Instant endDate)
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.
endDate - 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.CreateScheduleRequest.Builder flexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.default CreateScheduleRequest.Builder flexibleTimeWindow(Consumer<FlexibleTimeWindow.Builder> flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
This is a convenience method that creates an instance of theFlexibleTimeWindow.Builder avoiding the
need to create one manually via FlexibleTimeWindow.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to flexibleTimeWindow(FlexibleTimeWindow).
flexibleTimeWindow - a consumer that will call methods on FlexibleTimeWindow.BuilderflexibleTimeWindow(FlexibleTimeWindow)CreateScheduleRequest.Builder groupName(String groupName)
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
groupName - The name of the schedule group to associate with this schedule. If you omit this, the default schedule
group is used.CreateScheduleRequest.Builder kmsKeyArn(String kmsKeyArn)
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
kmsKeyArn - The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to
encrypt and decrypt your data.CreateScheduleRequest.Builder name(String name)
The name of the schedule that you are creating.
name - The name of the schedule that you are creating.CreateScheduleRequest.Builder scheduleExpression(String scheduleExpression)
The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(unit value)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time
and in the time zone, that you specify. You can use rate and cron expressions to
create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular
intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to
invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the
following options: minute | minutes | hour | hours |
day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
scheduleExpression - The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(unit value)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the
time and in the time zone, that you specify. You can use rate and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a
target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are
useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0)
every 1st day of the month.
A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit
with the following options: minute | minutes | hour |
hours | day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
CreateScheduleRequest.Builder scheduleExpressionTimezone(String scheduleExpressionTimezone)
The timezone in which the scheduling expression is evaluated.
scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.CreateScheduleRequest.Builder startDate(Instant startDate)
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.
startDate - 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.CreateScheduleRequest.Builder state(String state)
Specifies whether the schedule is enabled or disabled.
state - Specifies whether the schedule is enabled or disabled.ScheduleState,
ScheduleStateCreateScheduleRequest.Builder state(ScheduleState state)
Specifies whether the schedule is enabled or disabled.
state - Specifies whether the schedule is enabled or disabled.ScheduleState,
ScheduleStateCreateScheduleRequest.Builder target(Target target)
The schedule's target.
target - The schedule's target.default CreateScheduleRequest.Builder target(Consumer<Target.Builder> target)
The schedule's target.
This is a convenience method that creates an instance of theTarget.Builder avoiding the need to
create one manually via Target.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to target(Target).
target - a consumer that will call methods on Target.Buildertarget(Target)CreateScheduleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateScheduleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.