View a markdown version of this page

Schedule - EC2 Image Builder
ContentsSee Also

Schedule

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

Contents

autoDisablePolicy

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

Type: AutoDisablePolicy object

Required: No

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.

Type: String

Valid Values: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: