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

Interface ComponentDocument

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentDocument.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.440Z")
@Stability(Experimental)
public interface ComponentDocument
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of an EC2 Image Builder Component Document.

Example:

 Component component = Component.Builder.create(this, "StructuredComponent")
         .platform(Platform.LINUX)
         .data(ComponentData.fromComponentDocumentJsonObject(ComponentDocument.builder()
                 .schemaVersion(ComponentSchemaVersion.V1_0)
                 .phases(List.of(ComponentDocumentPhase.builder()
                         .name(ComponentPhaseName.BUILD)
                         .steps(List.of(ComponentDocumentStep.builder()
                                 .name("install-with-timeout")
                                 .action(ComponentAction.EXECUTE_BASH)
                                 .timeout(Duration.minutes(10))
                                 .onFailure(ComponentOnFailure.CONTINUE)
                                 .inputs(ComponentStepInputs.fromObject(Map.of(
                                         "commands", List.of("./install-script.sh"))))
                                 .build()))
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ComponentDocument.Builder	builder()
default Map<String,ComponentConstantValue>	getConstants()	(experimental) The constants to define in the document.
default String	getDescription()	(experimental) The description of the document.
default String	getName()	(experimental) The name of the document.
default Map<String,ComponentDocumentParameterDefinition>	getParameters()	(experimental) The parameters to define in the document.
List<ComponentDocumentPhase>	getPhases()	(experimental) The phases which define the grouping of steps to run in the build and test workflows of the image build.
ComponentSchemaVersion	getSchemaVersion()	(experimental) The schema version of the component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPhases

@Stability(Experimental)
@NotNull
List<ComponentDocumentPhase> getPhases()

(experimental) The phases which define the grouping of steps to run in the build and test workflows of the image build.

getSchemaVersion

@Stability(Experimental)
@NotNull
ComponentSchemaVersion getSchemaVersion()

(experimental) The schema version of the component.

getConstants

@Stability(Experimental)
@Nullable
default Map<String,ComponentConstantValue> getConstants()

(experimental) The constants to define in the document.

Default: None

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) The description of the document.

Default: None

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) The name of the document.

Default: None

getParameters

@Stability(Experimental)
@Nullable
default Map<String,ComponentDocumentParameterDefinition> getParameters()

(experimental) The parameters to define in the document.

Default: None

builder

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

Returns:

a ComponentDocument.Builder of ComponentDocument