Schedule
A schedule configures when and how often a pipeline will automatically create a new image.
Contents
- 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.
Type: String
Valid Values:
EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLERequired: 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 AWS SDKs, see the following:
