Interface CreateScheduleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>, SchedulerRequest.Builder, SdkBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateScheduleRequest
@Mutable @NotThreadSafe public static interface CreateScheduleRequest.Builder extends SchedulerRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>

  • Method Details

    • actionAfterCompletion

      CreateScheduleRequest.Builder actionAfterCompletion(String actionAfterCompletion)

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

      Parameters:
      actionAfterCompletion - Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionAfterCompletion

      CreateScheduleRequest.Builder actionAfterCompletion(ActionAfterCompletion actionAfterCompletion)

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

      Parameters:
      actionAfterCompletion - Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateScheduleRequest.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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateScheduleRequest.Builder description(String description)

      The description you specify for the schedule.

      Parameters:
      description - The description you specify for the schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flexibleTimeWindow

      CreateScheduleRequest.Builder flexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)

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

      Parameters:
      flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flexibleTimeWindow

      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 the FlexibleTimeWindow.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).

      Parameters:
      flexibleTimeWindow - a consumer that will call methods on FlexibleTimeWindow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupName

      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.

      Parameters:
      groupName - The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyArn

      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.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateScheduleRequest.Builder name(String name)

      The name of the schedule that you are creating.

      Parameters:
      name - The name of the schedule that you are creating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      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(value unit)

      • 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.

      Parameters:
      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(value unit)

      • 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpressionTimezone

      CreateScheduleRequest.Builder scheduleExpressionTimezone(String scheduleExpressionTimezone)

      The timezone in which the scheduling expression is evaluated.

      Parameters:
      scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      CreateScheduleRequest.Builder state(String state)

      Specifies whether the schedule is enabled or disabled.

      Parameters:
      state - Specifies whether the schedule is enabled or disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      CreateScheduleRequest.Builder state(ScheduleState state)

      Specifies whether the schedule is enabled or disabled.

      Parameters:
      state - Specifies whether the schedule is enabled or disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • target

      CreateScheduleRequest.Builder target(Target target)

      The schedule's target.

      Parameters:
      target - The schedule's target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      default CreateScheduleRequest.Builder target(Consumer<Target.Builder> target)

      The schedule's target.

      This is a convenience method that creates an instance of the Target.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).

      Parameters:
      target - a consumer that will call methods on Target.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateScheduleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateScheduleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.