interface ScheduleProperty

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnImagePipeline.ScheduleProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImagePipeline_ScheduleProperty
Java	software.amazon.awscdk.services.imagebuilder.CfnImagePipeline.ScheduleProperty
Python	aws_cdk.aws_imagebuilder.CfnImagePipeline.ScheduleProperty
TypeScript	aws-cdk-lib » aws_imagebuilder » CfnImagePipeline » ScheduleProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const scheduleProperty: imagebuilder.CfnImagePipeline.ScheduleProperty = {
  autoDisablePolicy: {
    failureCount: 123,
  },
  pipelineExecutionStartCondition: 'pipelineExecutionStartCondition',
  scheduleExpression: 'scheduleExpression',
};

Properties

Name	Type	Description
autoDisablePolicy?	IResolvable | AutoDisablePolicyProperty	The policy that configures when Image Builder should automatically disable a pipeline that is failing.
pipelineExecutionStartCondition?	string	The condition configures when the pipeline should trigger a new image build.
scheduleExpression?	string	The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition .

---

autoDisablePolicy?

Type: IResolvable | AutoDisablePolicyProperty (optional)

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

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

---

pipelineExecutionStartCondition?

Type: string (optional)

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

---

scheduleExpression?

Type: string (optional)

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