Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ComponentDocumentStep

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentDocumentStep.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-08T14:57:17.769Z")
@Stability(Experimental)
public interface ComponentDocumentStep
extends software.amazon.jsii.JsiiSerializable

(experimental) The step to run in a specific phase of the image build, which defines the step to execute to customize or test the instance.

Example:

 ComponentDocumentStep step = ComponentDocumentStep.builder()
         .name("configure-app")
         .action(ComponentAction.CREATE_FILE)
         .inputs(ComponentStepInputs.fromObject(Map.of(
                 "path", "/etc/myapp/config.json",
                 "content", "{\"env\": \"production\"}")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ComponentDocumentStep.Builder	A builder for ComponentDocumentStep
static final class	ComponentDocumentStep.Jsii$Proxy	An implementation for ComponentDocumentStep

Method Summary

Modifier and Type	Method	Description
static ComponentDocumentStep.Builder	builder()
ComponentAction	getAction()	(experimental) The action to perform in the step.
default ComponentStepIfCondition	getIfValue()	(experimental) The condition to apply to the step.
ComponentStepInputs	getInputs()	(experimental) Contains parameters required by the action to run the step.
default ComponentDocumentLoop	getLoop()	(experimental) A looping construct defining a repeated sequence of instructions.
String	getName()	(experimental) The name of the step.
default ComponentOnFailure	getOnFailure()	(experimental) Specifies what the step should do in case of failure.
default Duration	getTimeout()	(experimental) The timeout of the step.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Experimental)
@NotNull
ComponentAction getAction()

(experimental) The action to perform in the step.

getInputs

@Stability(Experimental)
@NotNull
ComponentStepInputs getInputs()

(experimental) Contains parameters required by the action to run the step.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-action-modules.html

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of the step.

getIfValue

@Stability(Experimental)
@Nullable
default ComponentStepIfCondition getIfValue()

(experimental) The condition to apply to the step.

If the condition is false, then the step is skipped

Default: - no condition is applied to the step and it gets executed

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-comparison-operators.html

getLoop

@Stability(Experimental)
@Nullable
default ComponentDocumentLoop getLoop()

(experimental) A looping construct defining a repeated sequence of instructions.

Default: None

getOnFailure

@Stability(Experimental)
@Nullable
default ComponentOnFailure getOnFailure()

(experimental) Specifies what the step should do in case of failure.

Default: ComponentOnFailure.ABORT

getTimeout

@Stability(Experimental)
@Nullable
default Duration getTimeout()

(experimental) The timeout of the step.

Default: - 120 minutes

builder

@Stability(Experimental)
static ComponentDocumentStep.Builder builder()

Returns:

a ComponentDocumentStep.Builder of ComponentDocumentStep