Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ImagePipelineStatus Enum
Indicates whether the pipeline is enabled to be triggered by the provided schedule.
| Stability | Experimental |
|---|---|
| Source | lib/image-pipeline.ts |
Example
ts
const advancedSchedulePipeline = new imagebuilder.ImagePipeline(this, 'AdvancedSchedulePipeline', {
recipe: exampleImageRecipe,
schedule: {
expression: events.Schedule.rate(Duration.days(7)),
// Only trigger when dependencies are updated (new base images, components, etc.)
startCondition: imagebuilder.ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
// Automatically disable after 3 consecutive failures
autoDisableFailureCount: 3
},
// Start enabled
status: imagebuilder.ImagePipelineStatus.ENABLED
});
python
advanced_schedule_pipeline = imagebuilder.ImagePipeline(self, "AdvancedSchedulePipeline",
recipe=example_image_recipe,
schedule=imagebuilder.ImagePipelineSchedule(
expression=events.Schedule.rate(Duration.days(7)),
# Only trigger when dependencies are updated (new base images, components, etc.)
start_condition=imagebuilder.ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
# Automatically disable after 3 consecutive failures
auto_disable_failure_count=3
),
# Start enabled
status=imagebuilder.ImagePipelineStatus.ENABLED
)
java
ImagePipeline advancedSchedulePipeline = ImagePipeline.Builder.create(this, "AdvancedSchedulePipeline")
.recipe(exampleImageRecipe)
.schedule(ImagePipelineSchedule.builder()
.expression(Schedule.rate(Duration.days(7)))
// Only trigger when dependencies are updated (new base images, components, etc.)
.startCondition(ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE)
// Automatically disable after 3 consecutive failures
.autoDisableFailureCount(3)
.build())
// Start enabled
.status(ImagePipelineStatus.ENABLED)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var advancedSchedulePipeline = new ImagePipeline(this, "AdvancedSchedulePipeline", new ImagePipelineProps {
Recipe = exampleImageRecipe,
Schedule = new ImagePipelineSchedule {
Expression = Schedule.Rate(Duration.Days(7)),
// Only trigger when dependencies are updated (new base images, components, etc.)
StartCondition = ScheduleStartCondition.EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
// Automatically disable after 3 consecutive failures
AutoDisableFailureCount = 3
},
// Start enabled
Status = ImagePipelineStatus.ENABLED
});
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
advancedSchedulePipeline := imagebuilder.NewImagePipeline(this, jsii.String("AdvancedSchedulePipeline"), &ImagePipelineProps{
Recipe: exampleImageRecipe,
Schedule: &ImagePipelineSchedule{
Expression: events.Schedule_Rate(awscdk.Duration_Days(jsii.Number(7))),
// Only trigger when dependencies are updated (new base images, components, etc.)
StartCondition: imagebuilder.ScheduleStartCondition_EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
// Automatically disable after 3 consecutive failures
AutoDisableFailureCount: jsii.Number(3),
},
// Start enabled
Status: imagebuilder.ImagePipelineStatus_ENABLED,
})
Members
| Member | Description |
|---|---|
ENABLED | Indicates that the pipeline is enabled for scheduling. |
DISABLED | Indicates that the pipeline is disabled and will not be triggered on the schedule. |
Referenced by
ImagePipelineProps.statusstatusstatusStatusStatus