Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ComponentDocument Struct
Properties of an EC2 Image Builder Component Document.
Example
ts
const component = new imagebuilder.Component(this, 'StructuredComponent', {
platform: imagebuilder.Platform.LINUX,
data: imagebuilder.ComponentData.fromComponentDocumentJsonObject({
schemaVersion: imagebuilder.ComponentSchemaVersion.V1_0,
phases: [
{
name: imagebuilder.ComponentPhaseName.BUILD,
steps: [
{
name: 'install-with-timeout',
action: imagebuilder.ComponentAction.EXECUTE_BASH,
timeout: Duration.minutes(10),
onFailure: imagebuilder.ComponentOnFailure.CONTINUE,
inputs: imagebuilder.ComponentStepInputs.fromObject({
commands: ['./install-script.sh']
})
}
]
}
]
})
});
Properties
constantsoptional{ [key: string]: ComponentConstantValue }constantsoptionaltyping.Mapping[str, ComponentConstantValue]constantsoptionalMap<String, ComponentConstantValue>ConstantsoptionalIDictionary<string, ComponentConstantValue>Constantsoptional*map[string]ComponentConstantValue= None#The constants to define in the document.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#The description of the document.
The name of the document.
parametersoptional{ [key: string]: ComponentDocumentParameterDefinition }parametersoptionaltyping.Mapping[str, ComponentDocumentParameterDefinition]parametersoptionalMap<String, ComponentDocumentParameterDefinition>ParametersoptionalIDictionary<string, ComponentDocumentParameterDefinition>Parametersoptional*map[string]ComponentDocumentParameterDefinition= None#The parameters to define in the document.
phasesComponentDocumentPhase[]phasestyping.List[ComponentDocumentPhase]phasesList<ComponentDocumentPhase>PhasesComponentDocumentPhase[]Phases*[]ComponentDocumentPhaserequired#The phases which define the grouping of steps to run in the build and test workflows of the image build.
schemaVersionComponentSchemaVersionschema_versionComponentSchemaVersionschemaVersionComponentSchemaVersionSchemaVersionComponentSchemaVersionSchemaVersionComponentSchemaVersionrequired#The schema version of the component.