Package software.amazon.awscdk.services.transfer

Interface CfnServer.WorkflowDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServer.WorkflowDetailsProperty.Jsii$Proxy

Enclosing class:

CfnServer

@Stability(Stable)
public static interface CfnServer.WorkflowDetailsProperty
extends software.amazon.jsii.JsiiSerializable

Container for the WorkflowDetail data type.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 WorkflowDetailsProperty workflowDetailsProperty = WorkflowDetailsProperty.builder()
         .onPartialUpload(List.of(WorkflowDetailProperty.builder()
                 .executionRole("executionRole")
                 .workflowId("workflowId")
                 .build()))
         .onUpload(List.of(WorkflowDetailProperty.builder()
                 .executionRole("executionRole")
                 .workflowId("workflowId")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServer.WorkflowDetailsProperty.Builder	A builder for CfnServer.WorkflowDetailsProperty
static final class	CfnServer.WorkflowDetailsProperty.Jsii$Proxy	An implementation for CfnServer.WorkflowDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnServer.WorkflowDetailsProperty.Builder	builder()
default Object	getOnPartialUpload()	A trigger that starts a workflow if a file is only partially uploaded.
default Object	getOnUpload()	A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOnPartialUpload

@Stability(Stable)
@Nullable
default Object getOnPartialUpload()

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.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

See Also:

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

getOnUpload

@Stability(Stable)
@Nullable
default Object getOnUpload()

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

OnUpload can contain a maximum of one WorkflowDetail object.

See Also:

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

builder

@Stability(Stable)
static CfnServer.WorkflowDetailsProperty.Builder builder()

Returns:

a CfnServer.WorkflowDetailsProperty.Builder of CfnServer.WorkflowDetailsProperty