Schedule ¶

class Schedule(TypedDict, closed=True):
    schedule_expression: NotRequired[
        "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    ]
    """<p>The expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>. You can specify a cron expression, or a rate expression such as <code>rate(1 day)</code>.</p> <p>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use cron expressions in EC2 Image Builder</a>.</p>"""
    timezone: NotRequired["capo_imagebuilder.types.timezone.Timezone"]
    """<p>The timezone that applies to the scheduling expression. Specify a value in <a href="https://www.joda.org/joda-time/timezones.html">IANA timezone format</a>, for example <code>Etc/UTC</code> or <code>America/Los_Angeles</code>. If not specified, this defaults to UTC.</p>"""
    pipeline_execution_start_condition: NotRequired[
        "capo_imagebuilder.types.pipeline_execution_start_condition.PipelineExecutionStartCondition"
    ]
    """<p>The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>.</p> <ul> <li> <p> <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code> (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.</p> <note> <p>For semantic version syntax, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html">CreateComponent</a>.</p> </note> </li> <li> <p> <code>EXPRESSION_MATCH_ONLY</code> – This condition builds a new image every time the CRON expression matches the current time.</p> </li> </ul> <note> <p>If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.</p> </note>"""
    auto_disable_policy: NotRequired[
        "capo_imagebuilder.types.auto_disable_policy.AutoDisablePolicy"
    ]
    """<p>The policy that configures when Image Builder should automatically disable a pipeline that is failing.</p>"""