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

Interface ComponentDocumentPhase

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentDocumentPhase.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:30.331Z")
@Stability(Experimental)
public interface ComponentDocumentPhase
extends software.amazon.jsii.JsiiSerializable

(experimental) The phase to run in a specific workflow in an image build, which define the steps to execute to customize or test the instance.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ComponentDocumentPhase.Builder	builder()
ComponentPhaseName	getName()	(experimental) The name of the phase.
List<ComponentDocumentStep>	getSteps()	(experimental) The list of steps to execute to modify or test the build/test instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Experimental)
@NotNull
ComponentPhaseName getName()

(experimental) The name of the phase.

getSteps

@Stability(Experimental)
@NotNull
List<ComponentDocumentStep> getSteps()

(experimental) The list of steps to execute to modify or test the build/test instance.

builder

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

Returns:

a ComponentDocumentPhase.Builder of ComponentDocumentPhase