WorkflowProps

class aws_cdk.aws_imagebuilder_alpha.WorkflowProps(*, data, workflow_type, change_description=None, description=None, kms_key=None, tags=None, workflow_name=None, workflow_version=None)

Bases: object

(experimental) Properties for creating a Workflow resource.

Parameters:

data (WorkflowData) – (experimental) The workflow document content that defines the image creation process.
workflow_type (WorkflowType) – (experimental) The phase in the image build process for which the workflow resource is responsible.
change_description (Optional[str]) – (experimental) 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. Default: None
description (Optional[str]) – (experimental) The description of the workflow. Default: None
kms_key (Optional[IKey]) – (experimental) The KMS key used to encrypt this workflow. Default: - an Image Builder owned key will be used to encrypt the workflow.
tags (Optional[Mapping[str, str]]) – (experimental) The tags to apply to the workflow. Default: None
workflow_name (Optional[str]) – (experimental) The name of the workflow. Default: - a name is generated
workflow_version (Optional[str]) – (experimental) The version of the workflow. Default: 1.0.0

Stability:

experimental

ExampleMetadata:

infused

Example:

workflow = imagebuilder.Workflow(self, "EncryptedWorkflow",
    workflow_type=imagebuilder.WorkflowType.BUILD,
    kms_key=kms.Key(self, "WorkflowKey"),
    data=imagebuilder.WorkflowData.from_json_object({
        "schema_version": imagebuilder.WorkflowSchemaVersion.V1_0,
        "steps": [{
            "name": "LaunchBuildInstance",
            "action": imagebuilder.WorkflowAction.LAUNCH_INSTANCE,
            "on_failure": imagebuilder.WorkflowOnFailure.ABORT,
            "inputs": {
                "wait_for": "ssmAgent"
            }
        }, {
            "name": "CreateImage",
            "action": imagebuilder.WorkflowAction.CREATE_IMAGE,
            "on_failure": imagebuilder.WorkflowOnFailure.ABORT,
            "inputs": {
                "instance_id": "i-123"
            }
        }, {
            "name": "TerminateInstance",
            "action": imagebuilder.WorkflowAction.TERMINATE_INSTANCE,
            "on_failure": imagebuilder.WorkflowOnFailure.CONTINUE,
            "inputs": {
                "instance_id": "i-123"
            }
        }
        ],
        "outputs": [{
            "name": "ImageId",
            "value": "$.stepOutputs.CreateImage.imageId"
        }
        ]
    })
)

Attributes

change_description

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

Default:: None
Stability:: experimental

data

(experimental) The workflow document content that defines the image creation process.

Stability:: experimental

description

(experimental) The description of the workflow.

Default:: None
Stability:: experimental

kms_key

(experimental) The KMS key used to encrypt this workflow.

Default:

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

Stability:

experimental

tags

(experimental) The tags to apply to the workflow.

Default:: None
Stability:: experimental

workflow_name

(experimental) The name of the workflow.

Default:

a name is generated

Stability:

experimental

workflow_type

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

Stability:: experimental

workflow_version

(experimental) The version of the workflow.

Default:: 1.0.0
Stability:: experimental