AWS::Transfer::Server WorkflowDetails - Amazon CloudFormation
SyntaxProperties
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::Server WorkflowDetails

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

Syntax

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

JSON

{
  "OnPartialUpload" : [ WorkflowDetail, ... ],
  "OnUpload" : [ WorkflowDetail, ... ]
}

Properties

OnPartialUpload

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

Note

OnPartialUpload can contain a maximum of one WorkflowDetail object.

Required: No

Type: Array of WorkflowDetail

Minimum: 0

Maximum: 1

Update requires: No interruption

OnUpload

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Note

OnUpload can contain a maximum of one WorkflowDetail object.

Required: No

Type: Array of WorkflowDetail

Minimum: 0

Maximum: 1

Update requires: No interruption