Class Schedule

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.Schedule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Schedule.Builder,Schedule>
@Generated("software.amazon.awssdk:codegen") public final class Schedule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Schedule.Builder,Schedule>

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

See Also:

  • Method Details

    • scheduleExpression

      public final String scheduleExpression()

      The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition . You can specify a cron expression, or a rate expression such as rate(1 day).

      For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

      Returns:
      The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition. You can specify a cron expression, or a rate expression such as rate(1 day).

      For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

    • timezone

      public final String timezone()

      The timezone that applies to the scheduling expression. Specify a value in IANA timezone format, for example Etc/UTC or America/Los_Angeles. If not specified, this defaults to UTC.

      Returns:
      The timezone that applies to the scheduling expression. Specify a value in IANA timezone format, for example Etc/UTC or America/Los_Angeles. If not specified, this defaults to UTC.

    • pipelineExecutionStartCondition

      public final 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.

      If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.

      If the service returns an enum value that is not available in the current SDK version, pipelineExecutionStartCondition will return PipelineExecutionStartCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pipelineExecutionStartConditionAsString().

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

      If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.

      See Also:

    • pipelineExecutionStartConditionAsString

      public final String pipelineExecutionStartConditionAsString()

      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.

      If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.

      If the service returns an enum value that is not available in the current SDK version, pipelineExecutionStartCondition will return PipelineExecutionStartCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pipelineExecutionStartConditionAsString().

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

      If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.

      See Also:

    • autoDisablePolicy

      public final AutoDisablePolicy autoDisablePolicy()

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

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

    • toBuilder

      public Schedule.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Schedule.Builder,Schedule>
      Returns:
      a builder for type T

    • builder

      public static Schedule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Schedule.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.