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.

Link

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.
import aws_cdk.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,
        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,
        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.

Link

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

Return type

Optional[str]

on_exception_steps

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, WorkflowStepProperty]], None]

steps

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, WorkflowStepProperty]]]

tags

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

Tags are metadata attached to workflows for any purpose.

Link

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

Return type

Optional[List[CfnTag]]