Schedule - EC2 Image Builder
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Schedule

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

Contents

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, EC2 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 EC2 Image Builder API Reference.

Type: String

Valid Values: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

Required: No

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.

Type: String

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

Required: No

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.

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 Amazon SDKs, see the following: