Skip to content
v2.277.0

WorkflowDetailsProperty Struct ​

Container for the WorkflowDetail data type.

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const workflowDetailsProperty: transfer.CfnServer.WorkflowDetailsProperty = {
  onPartialUpload: [{
    executionRole: 'executionRole',
    workflowId: 'workflowId',
  }],
  onUpload: [{
    executionRole: 'executionRole',
    workflowId: 'workflowId',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transfer as transfer

workflow_details_property = transfer.CfnServer.WorkflowDetailsProperty(
    on_partial_upload=[transfer.CfnServer.WorkflowDetailProperty(
        execution_role="executionRole",
        workflow_id="workflowId"
    )],
    on_upload=[transfer.CfnServer.WorkflowDetailProperty(
        execution_role="executionRole",
        workflow_id="workflowId"
    )]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

workflowDetailsProperty := &WorkflowDetailsProperty{
	OnPartialUpload: []interface{}{
		&WorkflowDetailProperty{
			ExecutionRole: jsii.String("executionRole"),
			WorkflowId: jsii.String("workflowId"),
		},
	},
	OnUpload: []interface{}{
		&WorkflowDetailProperty{
			ExecutionRole: jsii.String("executionRole"),
			WorkflowId: jsii.String("workflowId"),
		},
	},
}

Properties ​

onPartialUploadoptionalIResolvable | IResolvable | CfnServer.WorkflowDetailProperty[]on_partial_uploadoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowDetailProperty]]]onPartialUploadoptionalIResolvableOnPartialUploadoptionalIResolvableOnPartialUploadoptionalinterface{}#
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.

onUploadoptionalIResolvable | IResolvable | CfnServer.WorkflowDetailProperty[]on_uploadoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowDetailProperty]]]onUploadoptionalIResolvableOnUploadoptionalIResolvableOnUploadoptionalinterface{}#
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
notes

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.