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 CloudFormation template, use the following syntax:

JSON


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

YAML


  AutoDisablePolicy: 
    AutoDisablePolicy
  PipelineExecutionStartCondition: String
  ScheduleExpression: String
  Timezone: String

Properties

AutoDisablePolicy

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

Required: No

Type: AutoDisablePolicy

Update requires: No interruption

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.

Note
For semantic version syntax, see CreateComponent.
EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

Note

If the recipe references its base image through an AWS Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.

Required: No

Type: String

Allowed values: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

Update requires: No interruption

ScheduleExpression

The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition. You can specify a cron expression, or a rate expression such as rate(1 day).

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

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Timezone

The timezone that applies to the scheduling expression. Specify a value in IANA timezone format, for example Etc/UTC or America/Los_Angeles. If not specified, this defaults to UTC.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9]{2,}(?:\/[a-zA-Z0-9\-_+]+)*$

Minimum: 3

Maximum: 100

Update requires: No interruption

AWS::ImageBuilder::ImagePipeline Schedule

Syntax

JSON

YAML

Properties

Note

Note

See also