Skip to content

/AWS1/CL_IMGSCHEDULE

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_scheduleexpression TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

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.

iv_timezone TYPE /AWS1/IMGTIMEZONE /AWS1/IMGTIMEZONE

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.

iv_pipelineexecstartcond TYPE /AWS1/IMGPIPELINEEXECSTARTCOND /AWS1/IMGPIPELINEEXECSTARTCOND

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.

io_autodisablepolicy TYPE REF TO /AWS1/CL_IMGAUTODISABLEPOLICY /AWS1/CL_IMGAUTODISABLEPOLICY

The policy that configures when Image Builder should automatically disable a pipeline that is failing.

Queryable Attributes

scheduleExpression

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.

Accessible with the following methods

Method Description
GET_SCHEDULEEXPRESSION() Getter for SCHEDULEEXPRESSION, with configurable default
ASK_SCHEDULEEXPRESSION() Getter for SCHEDULEEXPRESSION w/ exceptions if field has no
HAS_SCHEDULEEXPRESSION() Determine if SCHEDULEEXPRESSION has a value

timezone

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.

Accessible with the following methods

Method Description
GET_TIMEZONE() Getter for TIMEZONE, with configurable default
ASK_TIMEZONE() Getter for TIMEZONE w/ exceptions if field has no value
HAS_TIMEZONE() Determine if TIMEZONE has a value

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.

Accessible with the following methods

Method Description
GET_PIPELINEEXECSTARTCOND() Getter for PIPELINEEXECUTIONSTARTCOND, with configurable def
ASK_PIPELINEEXECSTARTCOND() Getter for PIPELINEEXECUTIONSTARTCOND w/ exceptions if field
HAS_PIPELINEEXECSTARTCOND() Determine if PIPELINEEXECUTIONSTARTCOND has a value

autoDisablePolicy

The policy that configures when Image Builder should automatically disable a pipeline that is failing.

Accessible with the following methods

Method Description
GET_AUTODISABLEPOLICY() Getter for AUTODISABLEPOLICY