aws-cdk-lib.aws_transfer.CfnServer.WorkflowDetailProperty

interface WorkflowDetailProperty

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnServer.WorkflowDetailProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnServer_WorkflowDetailProperty
Javasoftware.amazon.awscdk.services.transfer.CfnServer.WorkflowDetailProperty
Pythonaws_cdk.aws_transfer.CfnServer.WorkflowDetailProperty
TypeScript aws-cdk-lib » aws_transfer » CfnServer » WorkflowDetailProperty

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

Example

// 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 workflowDetailProperty: transfer.CfnServer.WorkflowDetailProperty = {
  executionRole: 'executionRole',
  workflowId: 'workflowId',
};

Properties

NameTypeDescription
executionRolestringIncludes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources.
workflowIdstringA unique identifier for the workflow.

executionRole

Type: string

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources.


workflowId

Type: string

A unique identifier for the workflow.