Struct aws_sdk_scheduler::operation::update_schedule::builders::UpdateScheduleFluentBuilder

pub struct UpdateScheduleFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateSchedule.

Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update.

Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.

Implementations

impl UpdateScheduleFluentBuilder

pub fn as_input(&self) -> &UpdateScheduleInputBuilder

Access the UpdateSchedule as a reference.

pub async fn send( self ) -> Result<UpdateScheduleOutput, SdkError<UpdateScheduleError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<UpdateScheduleOutput, UpdateScheduleError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn name(self, input: impl Into<String>) -> Self

The name of the schedule that you are updating.

pub fn set_name(self, input: Option<String>) -> Self

The name of the schedule that you are updating.

pub fn get_name(&self) -> &Option<String>

The name of the schedule that you are updating.

pub fn group_name(self, input: impl Into<String>) -> Self

The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

pub fn set_group_name(self, input: Option<String>) -> Self

The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

pub fn get_group_name(&self) -> &Option<String>

The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

pub fn schedule_expression(self, input: impl Into<String>) -> Self

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.

pub fn set_schedule_expression(self, input: Option<String>) -> Self

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.

pub fn get_schedule_expression(&self) -> &Option<String>

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.

pub fn start_date(self, input: DateTime) -> Self

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.

pub fn set_start_date(self, input: Option<DateTime>) -> Self

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.

pub fn get_start_date(&self) -> &Option<DateTime>

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.

pub fn end_date(self, input: DateTime) -> Self

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.

pub fn set_end_date(self, input: Option<DateTime>) -> Self

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.

pub fn get_end_date(&self) -> &Option<DateTime>

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.

pub fn description(self, input: impl Into<String>) -> Self

The description you specify for the schedule.

pub fn set_description(self, input: Option<String>) -> Self

The description you specify for the schedule.

pub fn get_description(&self) -> &Option<String>

The description you specify for the schedule.

pub fn schedule_expression_timezone(self, input: impl Into<String>) -> Self

The timezone in which the scheduling expression is evaluated.

pub fn set_schedule_expression_timezone(self, input: Option<String>) -> Self

The timezone in which the scheduling expression is evaluated.

pub fn get_schedule_expression_timezone(&self) -> &Option<String>

The timezone in which the scheduling expression is evaluated.

pub fn state(self, input: ScheduleState) -> Self

Specifies whether the schedule is enabled or disabled.

pub fn set_state(self, input: Option<ScheduleState>) -> Self

Specifies whether the schedule is enabled or disabled.

pub fn get_state(&self) -> &Option<ScheduleState>

Specifies whether the schedule is enabled or disabled.

pub fn kms_key_arn(self, input: impl Into<String>) -> Self

The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

pub fn set_kms_key_arn(self, input: Option<String>) -> Self

The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

pub fn get_kms_key_arn(&self) -> &Option<String>

The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

pub fn target(self, input: Target) -> Self

The schedule target. You can use this operation to change the target that your schedule invokes.

pub fn set_target(self, input: Option<Target>) -> Self

The schedule target. You can use this operation to change the target that your schedule invokes.

pub fn get_target(&self) -> &Option<Target>

The schedule target. You can use this operation to change the target that your schedule invokes.

pub fn flexible_time_window(self, input: FlexibleTimeWindow) -> Self

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

pub fn set_flexible_time_window(self, input: Option<FlexibleTimeWindow>) -> Self

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

pub fn get_flexible_time_window(&self) -> &Option<FlexibleTimeWindow>

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

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

pub fn get_client_token(&self) -> &Option<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.

pub fn action_after_completion(self, input: ActionAfterCompletion) -> Self

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

pub fn set_action_after_completion( self, input: Option<ActionAfterCompletion> ) -> Self

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

pub fn get_action_after_completion(&self) -> &Option<ActionAfterCompletion>

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

Trait Implementations

impl Clone for UpdateScheduleFluentBuilder

fn clone(&self) -> UpdateScheduleFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateScheduleFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.