Struct aws_sdk_scheduler::operation::get_schedule::builders::GetScheduleOutputBuilder

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

A builder for GetScheduleOutput.

Implementations

impl GetScheduleOutputBuilder

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

The Amazon Resource Name (ARN) of the schedule.

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

The Amazon Resource Name (ARN) of the schedule.

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

The Amazon Resource Name (ARN) of the schedule.

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

The name of the schedule group associated with this schedule.

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

The name of the schedule group associated with this schedule.

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

The name of the schedule group associated with this schedule.

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

The name of the schedule.

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

The name of the schedule.

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

The name of the schedule.

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

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

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

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 of the schedule.

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

The description of the schedule.

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

The description of 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 creation_date(self, input: DateTime) -> Self

The time at which the schedule was created.

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

The time at which the schedule was created.

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

The time at which the schedule was created.

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

The time at which the schedule was last modified.

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

The time at which the schedule was last modified.

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

The time at which the schedule was last modified.

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

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

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

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

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

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

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

The schedule target.

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

The schedule target.

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

The schedule target.

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 build(self) -> GetScheduleOutput

Consumes the builder and constructs a GetScheduleOutput.

Trait Implementations

impl Clone for GetScheduleOutputBuilder

fn clone(&self) -> GetScheduleOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetScheduleOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetScheduleOutputBuilder

fn default() -> GetScheduleOutputBuilder

Returns the “default value” for a type.

impl PartialEq<GetScheduleOutputBuilder> for GetScheduleOutputBuilder

fn eq(&self, other: &GetScheduleOutputBuilder) -> 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 GetScheduleOutputBuilder