Class: Aws::Imagebuilder::Types::Schedule

Inherits:

Struct

Object
Struct
Aws::Imagebuilder::Types::Schedule

show all

Defined in:: gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Note:

When making an API call, you may pass Schedule data as a hash:

{
  schedule_expression: "NonEmptyString",
  pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
}

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#pipeline_execution_start_condition ⇒ String
The condition configures when the pipeline should trigger a new image build.
#schedule_expression ⇒ String
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

Instance Attribute Details

#pipeline_execution_start_condition ⇒ `String`

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 source image or components in your image recipe, EC2 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 EC2 Image Builder API Reference.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4379

class Schedule < Struct.new(
  :schedule_expression,
  :pipeline_execution_start_condition)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ `String`

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.