Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ImagePipelineSchedule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ImagePipelineSchedule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:50.061Z")
@Stability(Experimental)
public interface ImagePipelineSchedule
extends software.amazon.jsii.JsiiSerializable

(experimental) The schedule settings for the image pipeline, which defines when a pipeline should be triggered.

Example:

 ImagePipeline dailyPipeline = ImagePipeline.Builder.create(this, "DailyPipeline")
         .recipe(exampleContainerRecipe)
         .schedule(ImagePipelineSchedule.builder()
                 .expression(Schedule.rate(Duration.days(1)))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ImagePipelineSchedule.Builder	A builder for ImagePipelineSchedule
static final class	ImagePipelineSchedule.Jsii$Proxy	An implementation for ImagePipelineSchedule

Method Summary

Modifier and Type	Method	Description
static ImagePipelineSchedule.Builder	builder()
default Number	getAutoDisableFailureCount()	(experimental) The number of consecutive failures allowed before the pipeline is automatically disabled.
Schedule	getExpression()	(experimental) The schedule expression to use.
default ScheduleStartCondition	getStartCondition()	(experimental) The start condition for the pipeline, indicating the condition under which a pipeline should be triggered.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExpression

@Stability(Experimental)
@NotNull
Schedule getExpression()

(experimental) The schedule expression to use.

This can either be a cron expression or a rate expression.

getAutoDisableFailureCount

@Stability(Experimental)
@Nullable
default Number getAutoDisableFailureCount()

(experimental) The number of consecutive failures allowed before the pipeline is automatically disabled.

This value must be between 1 and 10.

Default: - no auto-disable policy is configured and the pipeline is not automatically disabled on consecutive failures

getStartCondition

@Stability(Experimental)
@Nullable
default ScheduleStartCondition getStartCondition()

(experimental) The start condition for the pipeline, indicating the condition under which a pipeline should be triggered.

Default: ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

builder

@Stability(Experimental)
static ImagePipelineSchedule.Builder builder()

Returns:

a ImagePipelineSchedule.Builder of ImagePipelineSchedule