Struct Schedule

#[non_exhaustive]
pub struct Schedule {
    pub schedule_expression: Option<String>,
    pub timezone: Option<String>,
    pub pipeline_execution_start_condition: Option<PipelineExecutionStartCondition>,
}

A schedule configures when and how often a pipeline will automatically create a new image.

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.

schedule_expression: Option<String>

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

timezone: Option<String>

The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

pipeline_execution_start_condition: Option<PipelineExecutionStartCondition>

The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

• EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.

  For semantic version syntax, see CreateComponent.

• EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

Implementations

impl Schedule

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

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

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

The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

pub fn pipeline_execution_start_condition( &self, ) -> Option<&PipelineExecutionStartCondition>

The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

• EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.

  For semantic version syntax, see CreateComponent.

• EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

impl Schedule

pub fn builder() -> ScheduleBuilder

Creates a new builder-style object to manufacture Schedule.

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl PartialEq for Schedule

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Schedule