Amazonka.ImageBuilder.Types.Schedule

Documentation

data Schedule

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

See: newSchedule smart constructor.

Constructors

Schedule'

Fields

• pipelineExecutionStartCondition :: Maybe PipelineExecutionStartCondition

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

• scheduleExpression :: Maybe Text

  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.

• timezone :: Maybe Text

  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.

Instances

FromJSON Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

parseJSON :: Value -> Parser Schedule

parseJSONList :: Value -> Parser [Schedule]

ToJSON Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

toJSON :: Schedule -> Value

toEncoding :: Schedule -> Encoding

toJSONList :: [Schedule] -> Value

toEncodingList :: [Schedule] -> Encoding

Generic Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Associated Types

type Rep Schedule :: Type -> Type

Methods

from :: Schedule -> Rep Schedule x

to :: Rep Schedule x -> Schedule

Read Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

readsPrec :: Int -> ReadS Schedule

readList :: ReadS [Schedule]

readPrec :: ReadPrec Schedule

readListPrec :: ReadPrec [Schedule]

Show Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

showsPrec :: Int -> Schedule -> ShowS

show :: Schedule -> String

showList :: [Schedule] -> ShowS

NFData Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

rnf :: Schedule -> ()

Eq Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

(==) :: Schedule -> Schedule -> Bool

(/=) :: Schedule -> Schedule -> Bool

Hashable Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

Methods

hashWithSalt :: Int -> Schedule -> Int

hash :: Schedule -> Int

type Rep Schedule

Defined in Amazonka.ImageBuilder.Types.Schedule

type Rep Schedule = D1 ('MetaData "Schedule" "Amazonka.ImageBuilder.Types.Schedule" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "Schedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionStartCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineExecutionStartCondition)) :*: (S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSchedule :: Schedule

Create a value of Schedule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pipelineExecutionStartCondition:Schedule', schedule_pipelineExecutionStartCondition - 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, 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.

$sel:scheduleExpression:Schedule', schedule_scheduleExpression - 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.

$sel:timezone:Schedule', schedule_timezone - 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.

schedule_pipelineExecutionStartCondition :: Lens' Schedule (Maybe PipelineExecutionStartCondition)

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

schedule_scheduleExpression :: Lens' Schedule (Maybe Text)

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.

schedule_timezone :: Lens' Schedule (Maybe Text)

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.