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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-imagebuilder/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#pipeline_execution_start_conditionString

The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to ‘EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`.

  • ‘EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE` (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.

    <note markdown=“1”> For semantic version syntax, see [CreateComponent].

    </note>
    
  • ‘EXPRESSION_MATCH_ONLY` – This condition builds a new image every time the CRON expression matches the current time.

[1]: docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
# File 'lib/aws-sdk-imagebuilder/types.rb', line 7455

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

#schedule_expressionString

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].

[1]: docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
# File 'lib/aws-sdk-imagebuilder/types.rb', line 7455

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

#timezoneString

The timezone that applies to the scheduling expression. For example, “Etc/UTC”, “America/Los_Angeles” in the [IANA timezone format]. If not specified this defaults to UTC.

[1]: www.joda.org/joda-time/timezones.html

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
# File 'lib/aws-sdk-imagebuilder/types.rb', line 7455

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