Skip to content
v2.277.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ImagePipelineSchedule Struct ​

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

Example ​

ts
const dailyPipeline = new imagebuilder.ImagePipeline(this, 'DailyPipeline', {
  recipe: exampleContainerRecipe,
  schedule: {
    expression: events.Schedule.rate(Duration.days(1))
  }
});
python
daily_pipeline = imagebuilder.ImagePipeline(self, "DailyPipeline",
    recipe=example_container_recipe,
    schedule=imagebuilder.ImagePipelineSchedule(
        expression=events.Schedule.rate(Duration.days(1))
    )
)
java
ImagePipeline dailyPipeline = ImagePipeline.Builder.create(this, "DailyPipeline")
        .recipe(exampleContainerRecipe)
        .schedule(ImagePipelineSchedule.builder()
                .expression(Schedule.rate(Duration.days(1)))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var dailyPipeline = new ImagePipeline(this, "DailyPipeline", new ImagePipelineProps {
    Recipe = exampleContainerRecipe,
    Schedule = new ImagePipelineSchedule {
        Expression = Schedule.Rate(Duration.Days(1))
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
dailyPipeline := imagebuilder.NewImagePipeline(this, jsii.String("DailyPipeline"), &ImagePipelineProps{
	Recipe: exampleContainerRecipe,
	Schedule: &ImagePipelineSchedule{
		Expression: events.Schedule_Rate(awscdk.Duration_Days(jsii.Number(1))),
	},
})

Properties ​

autoDisableFailureCountoptionalnumberauto_disable_failure_countoptionalint | floatautoDisableFailureCountoptionalNumberAutoDisableFailureCountoptionaldoubleAutoDisableFailureCountoptional*float64 #
The number of consecutive failures allowed before the pipeline is automatically disabled.

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

This value must be between 1 and 10.

expressionScheduleexpressionScheduleexpressionScheduleExpressionScheduleExpressionSchedule required #
The schedule expression to use.

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

startConditionoptionalScheduleStartConditionstart_conditionoptionalScheduleStartConditionstartConditionoptionalScheduleStartConditionStartConditionoptionalScheduleStartConditionStartConditionoptionalScheduleStartCondition #
The start condition for the pipeline, indicating the condition under which a pipeline should be triggered.

Default: ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE