@aws-cdk/aws-imagebuilder-alpha.WorkflowProps

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

WorkflowProps Struct

Properties for creating a Workflow resource.

WorkflowProps

used as props by

• Workflow

Stability

Experimental

Source

lib/workflow.ts

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

changeDescriptionstringchange_descriptionstrchangeDescriptionStringChangeDescriptionstringChangeDescription*string= 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.

dataWorkflowDatadataWorkflowDatadataWorkflowDataDataWorkflowDataDataWorkflowDatarequired#

The workflow document content that defines the image creation process.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= None#

The description of the workflow.

kmsKeyIKeykms_keyIKeykmsKeyIKeyKmsKeyIKeyKmsKeyIKey#

The KMS key used to encrypt this workflow.

Default: an Image Builder owned key will be used to encrypt the workflow.

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= None#

The tags to apply to the workflow.

workflowNamestringworkflow_namestrworkflowNameStringWorkflowNamestringWorkflowName*string#

The name of the workflow.

Default: a name is generated

workflowTypeWorkflowTypeworkflow_typeWorkflowTypeworkflowTypeWorkflowTypeWorkflowTypeWorkflowTypeWorkflowTypeWorkflowTyperequired#

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

workflowVersionstringworkflow_versionstrworkflowVersionStringWorkflowVersionstringWorkflowVersion*string= 1.0.0#

The version of the workflow.