interface ComponentDocument 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.ComponentDocument
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ComponentDocument
Java	software.amazon.awscdk.services.imagebuilder.alpha.ComponentDocument
Python	aws_cdk.aws_imagebuilder_alpha.ComponentDocument
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » ComponentDocument

Properties of an EC2 Image Builder Component Document.

Example

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

Name	Type	Description
phases🔹	ComponentDocumentPhase[]	The phases which define the grouping of steps to run in the build and test workflows of the image build.
schemaVersion🔹	ComponentSchemaVersion	The schema version of the component.
constants?🔹	{ [string]: ComponentConstantValue }	The constants to define in the document.
description?🔹	string	The description of the document.
name?🔹	string	The name of the document.
parameters?🔹	{ [string]: ComponentDocumentParameterDefinition }	The parameters to define in the document.

---

phases🔹

Type: ComponentDocumentPhase[]

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

---

schemaVersion🔹

Type: ComponentSchemaVersion

The schema version of the component.

---

constants?🔹

Type: { [string]: ComponentConstantValue } (optional, default: None)

The constants to define in the document.

---

description?🔹

Type: string (optional, default: None)

The description of the document.

---

name?🔹

Type: string (optional, default: None)

The name of the document.

---

parameters?🔹

Type: { [string]: ComponentDocumentParameterDefinition } (optional, default: None)

The parameters to define in the document.