Package software.amazon.awssdk.services.imagebuilder.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Schedule.Builder

Method Summary

Modifier and Type	Method	Description
static Schedule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PipelineExecutionStartCondition	pipelineExecutionStartCondition()	The start condition configures when the pipeline should trigger a new image build, as follows.
String	pipelineExecutionStartConditionAsString()	The start condition configures when the pipeline should trigger a new image build, as follows.
String	scheduleExpression()	The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Schedule.Builder>	serializableBuilderClass()
String	timezone()	The timezone that applies to the scheduling expression.
Schedule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scheduleExpression

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

Returns:

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

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

Returns:

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.

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

See Also:

PipelineExecutionStartCondition

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

See Also:

PipelineExecutionStartCondition

toBuilder

public Schedule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Schedule.Builder,Schedule>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo