@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,
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder_alpha as imagebuilder_alpha

# workflow: imagebuilder_alpha.Workflow
# workflow_parameter_value: imagebuilder_alpha.WorkflowParameterValue

workflow_configuration = imagebuilder_alpha.WorkflowConfiguration(
    workflow=workflow,

    # the properties below are optional
    on_failure=imagebuilder_alpha.WorkflowOnFailure.ABORT,
    parallel_group="parallelGroup",
    parameters={
        "parameters_key": workflow_parameter_value
    }
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.imagebuilder.alpha.*;

Workflow workflow;
WorkflowParameterValue workflowParameterValue;

WorkflowConfiguration workflowConfiguration = WorkflowConfiguration.builder()
        .workflow(workflow)

        // the properties below are optional
        .onFailure(WorkflowOnFailure.ABORT)
        .parallelGroup("parallelGroup")
        .parameters(Map.of(
                "parametersKey", workflowParameterValue))
        .build();

// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder.Alpha;

Workflow workflow;
WorkflowParameterValue workflowParameterValue;

var workflowConfiguration = new WorkflowConfiguration {
    Workflow = workflow,

    // the properties below are optional
    OnFailure = WorkflowOnFailure.ABORT,
    ParallelGroup = "parallelGroup",
    Parameters = new Dictionary<string, WorkflowParameterValue> {
        { "parametersKey", workflowParameterValue }
    }
};

// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import imagebuilder_alpha "github.com/aws/aws-cdk-go/awsimagebuilderalpha"

var workflow Workflow
var workflowParameterValue WorkflowParameterValue

workflowConfiguration := &WorkflowConfiguration{
	Workflow: workflow,

	// the properties below are optional
	OnFailure: imagebuilder_alpha.WorkflowOnFailure_ABORT,
	ParallelGroup: jsii.String("parallelGroup"),
	Parameters: map[string]WorkflowParameterValue{
		"parametersKey": workflowParameterValue,
	},
}

Properties

onFailure?optionalWorkflowOnFailureon_failure?optionalWorkflowOnFailureonFailure?optionalWorkflowOnFailureOnFailure?optionalWorkflowOnFailureOnFailure?optionalWorkflowOnFailure= WorkflowOnFailure.ABORT#

The action to take if the workflow fails.

parallelGroup?optionalstringparallel_group?optionalstrparallelGroup?optionalStringParallelGroup?optionalstringParallelGroup?optional*string= None#

The named parallel group to include this workflow in.

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

parameters?optional{ [key: string]: WorkflowParameterValue }parameters?optionaltyping.Mapping[str, WorkflowParameterValue]parameters?optionalMap<String, WorkflowParameterValue>Parameters?optionalIDictionary<string, WorkflowParameterValue>Parameters?optional*map[string]WorkflowParameterValue#

The parameters to pass to the workflow at execution time.

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

workflowIWorkflowworkflowIWorkflowworkflowIWorkflowWorkflowIWorkflowWorkflowIWorkflowrequired#

The workflow to execute in the image build.