Interface CfnImagePipeline.IScheduleProperty

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

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnImagePipeline.IScheduleProperty

Syntax (vb)

Public Interface CfnImagePipeline.IScheduleProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ImageBuilder;

             var scheduleProperty = new ScheduleProperty {
                 AutoDisablePolicy = new AutoDisablePolicyProperty {
                     FailureCount = 123
                 },
                 PipelineExecutionStartCondition = "pipelineExecutionStartCondition",
                 ScheduleExpression = "scheduleExpression"
             };

Synopsis

Properties

AutoDisablePolicy	The policy that configures when Image Builder should automatically disable a pipeline that is failing.
PipelineExecutionStartCondition	The condition configures when the pipeline should trigger a new image build.
ScheduleExpression	The cron expression determines how often EC2 Image Builder evaluates your `pipelineExecutionStartCondition` .

Properties

AutoDisablePolicy

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

object? AutoDisablePolicy { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnImagePipeline.IAutoDisablePolicyProperty

PipelineExecutionStartCondition

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

string? PipelineExecutionStartCondition { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-pipelineexecutionstartcondition

ScheduleExpression

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition .

string? ScheduleExpression { get; }

Property Value

string

Remarks

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder .

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