interface WorkflowProps 🔹

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

Properties for creating a Workflow resource.

Example

const workflow = new imagebuilder.Workflow(this, 'EncryptedWorkflow', {
  workflowType: imagebuilder.WorkflowType.BUILD,
  kmsKey: new kms.Key(this, 'WorkflowKey'),
  data: imagebuilder.WorkflowData.fromJsonObject({
    schemaVersion: imagebuilder.WorkflowSchemaVersion.V1_0,
    steps: [
      {
        name: 'LaunchBuildInstance',
        action: imagebuilder.WorkflowAction.LAUNCH_INSTANCE,
        onFailure: imagebuilder.WorkflowOnFailure.ABORT,
        inputs: {
          waitFor: 'ssmAgent',
        },
      },
      {
        name: 'CreateImage',
        action: imagebuilder.WorkflowAction.CREATE_IMAGE,
        onFailure: imagebuilder.WorkflowOnFailure.ABORT,
        inputs: {
          'instanceId': 'i-123',
        },
      },
      {
        name: 'TerminateInstance',
        action: imagebuilder.WorkflowAction.TERMINATE_INSTANCE,
        onFailure: imagebuilder.WorkflowOnFailure.CONTINUE,
        inputs: {
          'instanceId': 'i-123',
        },
      },
    ],
    outputs: [
      {
        name: 'ImageId',
        value: '$.stepOutputs.CreateImage.imageId',
      },
    ],
  }),
});

Properties

Name	Type	Description
data🔹	WorkflowData	The workflow document content that defines the image creation process.
workflowType🔹	WorkflowType	The phase in the image build process for which the workflow resource is responsible.
changeDescription?🔹	string	The change description of the workflow.
description?🔹	string	The description of the workflow.
kmsKey?🔹	IKey	The KMS key used to encrypt this workflow.
tags?🔹	{ [string]: string }	The tags to apply to the workflow.
workflowName?🔹	string	The name of the workflow.
workflowVersion?🔹	string	The version of the workflow.

---

data🔹

Type: WorkflowData

The workflow document content that defines the image creation process.

---

workflowType🔹

Type: WorkflowType

The phase in the image build process for which the workflow resource is responsible.

---

changeDescription?🔹

Type: string (optional, default: None)

The change description of the workflow.

Describes what change has been made in this version of the workflow, or what makes this version different from other versions.

---

description?🔹

Type: string (optional, default: None)

The description of the workflow.

---

kmsKey?🔹

Type: IKey (optional, default: an Image Builder owned key will be used to encrypt the workflow.)

The KMS key used to encrypt this workflow.

---

tags?🔹

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

The tags to apply to the workflow.

---

workflowName?🔹

Type: string (optional, default: a name is generated)

The name of the workflow.

---

workflowVersion?🔹

Type: string (optional, default: 1.0.0)

The version of the workflow.