ComponentDocument

class aws_cdk.aws_imagebuilder_alpha.ComponentDocument(*, phases, schema_version, constants=None, description=None, name=None, parameters=None)

Bases: object

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

Parameters:

phases (Sequence[Union[ComponentDocumentPhase, Dict[str, Any]]]) – (experimental) The phases which define the grouping of steps to run in the build and test workflows of the image build.
schema_version (ComponentSchemaVersion) – (experimental) The schema version of the component.
constants (Optional[Mapping[str, ComponentConstantValue]]) – (experimental) The constants to define in the document. Default: None
description (Optional[str]) – (experimental) The description of the document. Default: None
name (Optional[str]) – (experimental) The name of the document. Default: None
parameters (Optional[Mapping[str, Union[ComponentDocumentParameterDefinition, Dict[str, Any]]]]) – (experimental) The parameters to define in the document. Default: None

Stability:

experimental

ExampleMetadata:

infused

Example:

component = imagebuilder.Component(self, "StructuredComponent",
    platform=imagebuilder.Platform.LINUX,
    data=imagebuilder.ComponentData.from_component_document_json_object(
        schema_version=imagebuilder.ComponentSchemaVersion.V1_0,
        phases=[imagebuilder.ComponentDocumentPhase(
            name=imagebuilder.ComponentPhaseName.BUILD,
            steps=[imagebuilder.ComponentDocumentStep(
                name="install-with-timeout",
                action=imagebuilder.ComponentAction.EXECUTE_BASH,
                timeout=Duration.minutes(10),
                on_failure=imagebuilder.ComponentOnFailure.CONTINUE,
                inputs=imagebuilder.ComponentStepInputs.from_object({
                    "commands": ["./install-script.sh"]
                })
            )
            ]
        )
        ]
    )
)

Attributes

constants

(experimental) The constants to define in the document.

Default:: None
Stability:: experimental

description

(experimental) The description of the document.

Default:: None
Stability:: experimental

name

(experimental) The name of the document.

Default:: None
Stability:: experimental

parameters

(experimental) The parameters to define in the document.

Default:: None
Stability:: experimental

phases

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

Stability:: experimental

schema_version

(experimental) The schema version of the component.

Stability:: experimental