Package software.amazon.awscdk.services.imagebuilder

Interface CfnImagePipeline.ScheduleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImagePipeline.ScheduleProperty.Jsii$Proxy

Enclosing class:

CfnImagePipeline

@Stability(Stable)
public static interface CfnImagePipeline.ScheduleProperty
extends software.amazon.jsii.JsiiSerializable

A schedule configures when and how often a pipeline will automatically create a new image.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 ScheduleProperty scheduleProperty = ScheduleProperty.builder()
         .autoDisablePolicy(AutoDisablePolicyProperty.builder()
                 .failureCount(123)
                 .build())
         .pipelineExecutionStartCondition("pipelineExecutionStartCondition")
         .scheduleExpression("scheduleExpression")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnImagePipeline.ScheduleProperty.Builder	builder()
default Object	getAutoDisablePolicy()	The policy that configures when Image Builder should automatically disable a pipeline that is failing.
default String	getPipelineExecutionStartCondition()	The condition configures when the pipeline should trigger a new image build.
default String	getScheduleExpression()	The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoDisablePolicy

@Stability(Stable)
@Nullable
default Object getAutoDisablePolicy()

The policy that configures when Image Builder should automatically disable a pipeline that is failing.

Returns union: either IResolvable or CfnImagePipeline.AutoDisablePolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-autodisablepolicy

getPipelineExecutionStartCondition

@Stability(Stable)
@Nullable
default String getPipelineExecutionStartCondition()

The condition configures when the pipeline should trigger a new image build.

When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the Image Builder API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-pipelineexecutionstartcondition

getScheduleExpression

@Stability(Stable)
@Nullable
default String getScheduleExpression()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-scheduleexpression

builder

@Stability(Stable)
static CfnImagePipeline.ScheduleProperty.Builder builder()

Returns:

a CfnImagePipeline.ScheduleProperty.Builder of CfnImagePipeline.ScheduleProperty