Struct aws_sdk_scheduler::operation::create_schedule::CreateScheduleInput

#[non_exhaustive]
pub struct CreateScheduleInput {

    pub name: Option<String>,
    pub group_name: Option<String>,
    pub schedule_expression: Option<String>,
    pub start_date: Option<DateTime>,
    pub end_date: Option<DateTime>,
    pub description: Option<String>,
    pub schedule_expression_timezone: Option<String>,
    pub state: Option<ScheduleState>,
    pub kms_key_arn: Option<String>,
    pub target: Option<Target>,
    pub flexible_time_window: Option<FlexibleTimeWindow>,
    pub client_token: Option<String>,
    pub action_after_completion: Option<ActionAfterCompletion>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the schedule that you are creating.

group_name: Option<String>

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

schedule_expression: 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.

start_date: 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.

end_date: 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.

description: Option<String>

The description you specify for the schedule.

schedule_expression_timezone: Option<String>

The timezone in which the scheduling expression is evaluated.

state: Option<ScheduleState>

Specifies whether the schedule is enabled or disabled.

kms_key_arn: Option<String>

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

target: Option<Target>

The schedule's target.

flexible_time_window: Option<FlexibleTimeWindow>

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

client_token: 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.

action_after_completion: Option<ActionAfterCompletion>

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

Implementations

impl CreateScheduleInput

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

The name of the schedule that you are creating.

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.

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(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) -> 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) -> 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) -> Option<&str>

The description you specify for the schedule.

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

The timezone in which the scheduling expression is evaluated.

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

Specifies whether the schedule is enabled or disabled.

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.

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

The schedule's target.

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

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

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

impl CreateScheduleInput

pub fn builder() -> CreateScheduleInputBuilder

Creates a new builder-style object to manufacture CreateScheduleInput.

Trait Implementations

impl Clone for CreateScheduleInput

fn clone(&self) -> CreateScheduleInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateScheduleInput

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

Formats the value using the given formatter.

impl PartialEq for CreateScheduleInput

fn eq(&self, other: &CreateScheduleInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateScheduleInput