AWS::Transfer::Workflow - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Transfer::Workflow

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Transfer::Workflow",
  "Properties" : {
      "Description" : String,
      "OnExceptionSteps" : [ WorkflowStep, ... ],
      "Steps" : [ WorkflowStep, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Transfer::Workflow
Properties:
  Description: String
  OnExceptionSteps: 
    - WorkflowStep
  Steps: 
    - WorkflowStep
  Tags: 
    - Tag

Properties

Description

Specifies the text description for the workflow.

Required: No

Type: String

Pattern: ^[\w\- ]*$

Minimum: 0

Maximum: 256

Update requires: Replacement

OnExceptionSteps

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

Required: No

Type: Array of WorkflowStep

Maximum: 8

Update requires: Replacement

Steps

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

Required: Yes

Type: Array of WorkflowStep

Maximum: 8

Update requires: Replacement

Tags

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

WorkflowId

A unique identifier for a workflow.