WorkflowConfiguration

class aws_cdk.aws_imagebuilder_alpha.WorkflowConfiguration(*, workflow, on_failure=None, parallel_group=None, parameters=None)

Bases: object

(experimental) Configuration details for a workflow.

Parameters:

  • workflow (IWorkflow) – (experimental) The workflow to execute in the image build.

  • on_failure (Optional[WorkflowOnFailure]) – (experimental) The action to take if the workflow fails. Default: WorkflowOnFailure.ABORT

  • parallel_group (Optional[str]) – (experimental) The named parallel group to include this workflow in. Workflows in the same parallel group run in parallel of each other. Default: None

  • parameters (Optional[Mapping[str, WorkflowParameterValue]]) – (experimental) 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

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# 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
    }
)

Attributes

on_failure

(experimental) The action to take if the workflow fails.

Default:

WorkflowOnFailure.ABORT

Stability:

experimental

parallel_group

(experimental) The named parallel group to include this workflow in.

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

Default:

None

Stability:

experimental

parameters

(experimental) 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

Stability:

experimental

workflow

(experimental) The workflow to execute in the image build.

Stability:

experimental