interface ComponentDocumentStep 🔹

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

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

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

Name	Type	Description
action🔹	ComponentAction	The action to perform in the step.
inputs🔹	ComponentStepInputs	Contains parameters required by the action to run the step.
name🔹	string	The name of the step.
if?🔹	ComponentStepIfCondition	The condition to apply to the step.
loop?🔹	ComponentDocumentLoop	A looping construct defining a repeated sequence of instructions.
onFailure?🔹	ComponentOnFailure	Specifies what the step should do in case of failure.
timeout?🔹	Duration	The timeout of the step.

---

action🔹

Type: ComponentAction

The action to perform in the step.

---

inputs🔹

Type: ComponentStepInputs

Contains parameters required by the action to run the step.

See also: https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-action-modules.html

---

name🔹

Type: string

The name of the step.

---

if?🔹

Type: ComponentStepIfCondition (optional, default: no condition is applied to the step and it gets executed)

The condition to apply to the step.

If the condition is false, then the step is skipped

See also: https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-comparison-operators.html

---

loop?🔹

Type: ComponentDocumentLoop (optional, default: None)

A looping construct defining a repeated sequence of instructions.

---

onFailure?🔹

Type: ComponentOnFailure (optional, default: ComponentOnFailure.ABORT)

Specifies what the step should do in case of failure.

---

timeout?🔹

Type: Duration (optional, default: 120 minutes)

The timeout of the step.