CfnWorkflowProps

class aws_cdk.aws_transfer.CfnWorkflowProps(*, steps, description=None, on_exception_steps=None, tags=None)

Bases: object

Properties for defining a CfnWorkflow.

Parameters:

steps (Union[IResolvable, Sequence[Union[IResolvable, WorkflowStepProperty, Dict[str, Any]]]]) – Specifies the details for the steps that are in the specified workflow.
description (Optional[str]) – Specifies the text description for the workflow.
on_exception_steps (Union[IResolvable, Sequence[Union[IResolvable, WorkflowStepProperty, Dict[str, Any]]], None]) – Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

ExampleMetadata:

fixture=_generated

Example:

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

# copy_step_details: Any
# custom_step_details: Any
# delete_step_details: Any
# tag_step_details: Any

cfn_workflow_props = transfer.CfnWorkflowProps(
    steps=[transfer.CfnWorkflow.WorkflowStepProperty(
        copy_step_details=copy_step_details,
        custom_step_details=custom_step_details,
        decrypt_step_details=transfer.CfnWorkflow.DecryptStepDetailsProperty(
            destination_file_location=transfer.CfnWorkflow.InputFileLocationProperty(
                efs_file_location=transfer.CfnWorkflow.EfsInputFileLocationProperty(
                    file_system_id="fileSystemId",
                    path="path"
                ),
                s3_file_location=transfer.CfnWorkflow.S3InputFileLocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            name="name",
            overwrite_existing="overwriteExisting",
            source_file_location="sourceFileLocation",
            type="type"
        ),
        delete_step_details=delete_step_details,
        tag_step_details=tag_step_details,
        type="type"
    )],

    # the properties below are optional
    description="description",
    on_exception_steps=[transfer.CfnWorkflow.WorkflowStepProperty(
        copy_step_details=copy_step_details,
        custom_step_details=custom_step_details,
        decrypt_step_details=transfer.CfnWorkflow.DecryptStepDetailsProperty(
            destination_file_location=transfer.CfnWorkflow.InputFileLocationProperty(
                efs_file_location=transfer.CfnWorkflow.EfsInputFileLocationProperty(
                    file_system_id="fileSystemId",
                    path="path"
                ),
                s3_file_location=transfer.CfnWorkflow.S3InputFileLocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            name="name",
            overwrite_existing="overwriteExisting",
            source_file_location="sourceFileLocation",
            type="type"
        ),
        delete_step_details=delete_step_details,
        tag_step_details=tag_step_details,
        type="type"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

Specifies the text description for the workflow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-description

on_exception_steps

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-onexceptionsteps

steps

Specifies the details for the steps that are in the specified workflow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-steps

tags

Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-tags