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

Experimental

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

WorkflowConfiguration Struct

Configuration details for a workflow.

Stability

Experimental

Source

lib/workflow.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder_alpha from '@aws-cdk/aws-imagebuilder-alpha';

declare const workflow: imagebuilder_alpha.Workflow;
declare const workflowParameterValue: imagebuilder_alpha.WorkflowParameterValue;
const workflowConfiguration: imagebuilder_alpha.WorkflowConfiguration = {
  workflow: workflow,

  // the properties below are optional
  onFailure: imagebuilder_alpha.WorkflowOnFailure.ABORT,
  parallelGroup: 'parallelGroup',
  parameters: {
    parametersKey: workflowParameterValue,
  },
};

Properties

onFailureWorkflowOnFailureon_failureWorkflowOnFailureonFailureWorkflowOnFailureOnFailureWorkflowOnFailureOnFailureWorkflowOnFailure= WorkflowOnFailure.ABORT#

The action to take if the workflow fails.

parallelGroupstringparallel_groupstrparallelGroupStringParallelGroupstringParallelGroup*string= None#

The named parallel group to include this workflow in.

Workflows in the same parallel group run in parallel of each other.

parameters{ [key: string]: WorkflowParameterValue }parameterstyping.Mapping[str, WorkflowParameterValue]parametersMap<String, WorkflowParameterValue>ParametersIDictionary<string, WorkflowParameterValue>Parameters*map[string]WorkflowParameterValue= none if the workflow has no para…#

The parameters to pass to the workflow at execution time.

default

Default: none if the workflow has no parameters, otherwise the default parameter values are used

workflowIWorkflowworkflowIWorkflowworkflowIWorkflowWorkflowIWorkflowWorkflowIWorkflowrequired#

The workflow to execute in the image build.