AWS::ImageBuilder::ImagePipeline Schedule

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "PipelineExecutionStartCondition" : String,
  "ScheduleExpression" : String
}

YAML


  PipelineExecutionStartCondition: String
  ScheduleExpression: String

Properties

PipelineExecutionStartCondition

The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the Image Builder API Reference.

Required: No

Type: String

Allowed values: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

Update requires: No interruption

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.