Struct aws_sdk_scheduler::input::CreateScheduleInput

source ·

#[non_exhaustive]
pub struct CreateScheduleInput { /* private fields */ }

Implementations§

source §

impl CreateScheduleInput

source

pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateSchedule, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<CreateSchedule>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateScheduleInput.

source §

impl CreateScheduleInput

source

pub fn name(&self) -> Option<&str>

The name of the schedule that you are creating.

source

pub fn group_name(&self) -> Option<&str>

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

source

pub fn schedule_expression(&self) -> Option<&str>

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

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

source

pub fn 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.

source

pub fn 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.

source

pub fn description(&self) -> Option<&str>

The description you specify for the schedule.

source

pub fn schedule_expression_timezone(&self) -> Option<&str>

The timezone in which the scheduling expression is evaluated.

source

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

Specifies whether the schedule is enabled or disabled.

source

pub fn kms_key_arn(&self) -> Option<&str>

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

source

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

The schedule's target.

source

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

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

source

pub fn client_token(&self) -> Option<&str>

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.