Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ComponentDocumentStep Struct
The step to run in a specific phase of the image build, which defines the step to execute to customize or test the instance.
Example
ts
const step: imagebuilder.ComponentDocumentStep = {
name: 'configure-app',
action: imagebuilder.ComponentAction.CREATE_FILE,
inputs: imagebuilder.ComponentStepInputs.fromObject({
path: '/etc/myapp/config.json',
content: '{"env": "production"}'
})
};
Properties
actionComponentActionactionComponentActionactionComponentActionActionComponentActionActionComponentActionrequired#The action to perform in the step.
ifoptionalComponentStepIfConditionifoptionalComponentStepIfConditionifoptionalComponentStepIfConditionIfoptionalComponentStepIfConditionIfoptionalComponentStepIfCondition#The condition to apply to the step.
Default: no condition is applied to the step and it gets executed
If the condition is false, then the step is skipped
inputsComponentStepInputsinputsComponentStepInputsinputsComponentStepInputsInputsComponentStepInputsInputsComponentStepInputsrequired#Contains parameters required by the action to run the step.
loopoptionalComponentDocumentLooploopoptionalComponentDocumentLooploopoptionalComponentDocumentLoopLoopoptionalComponentDocumentLoopLoopoptionalComponentDocumentLoop= None#A looping construct defining a repeated sequence of instructions.
The name of the step.
onFailureoptionalComponentOnFailureon_failureoptionalComponentOnFailureonFailureoptionalComponentOnFailureOnFailureoptionalComponentOnFailureOnFailureoptionalComponentOnFailure= ComponentOnFailure.ABORT#Specifies what the step should do in case of failure.