Interface Schedule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Schedule.Builder,Schedule>, SdkBuilder<Schedule.Builder,Schedule>, SdkPojo
Enclosing class:
Schedule
@Mutable @NotThreadSafe public static interface Schedule.Builder extends SdkPojo, CopyableBuilder<Schedule.Builder,Schedule>

  • Method Details

    • scheduleExpression

      Schedule.Builder scheduleExpression(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      Schedule.Builder timezone(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineExecutionStartCondition

      Schedule.Builder pipelineExecutionStartCondition(String pipelineExecutionStartCondition)

      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.

        For semantic version syntax, see CreateComponent.

      • EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

      Parameters:
      pipelineExecutionStartCondition - 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.

        For semantic version syntax, see CreateComponent.

      • EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipelineExecutionStartCondition

      Schedule.Builder pipelineExecutionStartCondition(PipelineExecutionStartCondition pipelineExecutionStartCondition)

      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.

        For semantic version syntax, see CreateComponent.

      • EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

      Parameters:
      pipelineExecutionStartCondition - 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.

        For semantic version syntax, see CreateComponent.

      • EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoDisablePolicy

      Schedule.Builder autoDisablePolicy(AutoDisablePolicy autoDisablePolicy)

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

      Parameters:
      autoDisablePolicy - The policy that configures when Image Builder should automatically disable a pipeline that is failing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoDisablePolicy

      default Schedule.Builder autoDisablePolicy(Consumer<AutoDisablePolicy.Builder> autoDisablePolicy)

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

      This is a convenience method that creates an instance of the AutoDisablePolicy.Builder avoiding the need to create one manually via AutoDisablePolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoDisablePolicy(AutoDisablePolicy).

      Parameters:
      autoDisablePolicy - a consumer that will call methods on AutoDisablePolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: