Interface CfnServer.IWorkflowDetailsProperty

Container for the WorkflowDetail data type.

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnServer.IWorkflowDetailsProperty

Syntax (vb)

Public Interface CfnServer.IWorkflowDetailsProperty

Remarks

It is used by actions that trigger a workflow to begin execution.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var workflowDetailsProperty = new WorkflowDetailsProperty {
                 OnPartialUpload = new [] { new WorkflowDetailProperty {
                     ExecutionRole = "executionRole",
                     WorkflowId = "workflowId"
                 } },
                 OnUpload = new [] { new WorkflowDetailProperty {
                     ExecutionRole = "executionRole",
                     WorkflowId = "workflowId"
                 } }
             };

Synopsis

Properties

OnPartialUpload	A trigger that starts a workflow if a file is only partially uploaded.
OnUpload	A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

Properties

OnPartialUpload

A trigger that starts a workflow if a file is only partially uploaded.

object? OnPartialUpload { get; }

Property Value

object

Remarks

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.

<code>OnPartialUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onpartialupload

Type union: either IResolvable or (either IResolvable or CfnServer.IWorkflowDetailProperty)[]

OnUpload

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

object? OnUpload { get; }

Property Value

object

Remarks

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":[]}'

<code>OnUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onupload

Type union: either IResolvable or (either IResolvable or CfnServer.IWorkflowDetailProperty)[]