Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Interface CfnServerPropsMixin.WorkflowDetailProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServerPropsMixin.WorkflowDetailProperty.Jsii$Proxy

Enclosing class:

CfnServerPropsMixin

@Stability(Stable)
public static interface CfnServerPropsMixin.WorkflowDetailProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.transfer.*;
 WorkflowDetailProperty workflowDetailProperty = WorkflowDetailProperty.builder()
         .executionRole("executionRole")
         .workflowId("workflowId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServerPropsMixin.WorkflowDetailProperty.Builder	builder()
default String	getExecutionRole()	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.
default String	getWorkflowId()	A unique identifier for the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRole

@Stability(Stable)
@Nullable
default String getExecutionRole()

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.

See Also:

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

getWorkflowId

@Stability(Stable)
@Nullable
default String getWorkflowId()

A unique identifier for the workflow.

See Also:

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

builder

@Stability(Stable)
static CfnServerPropsMixin.WorkflowDetailProperty.Builder builder()

Returns:

a CfnServerPropsMixin.WorkflowDetailProperty.Builder of CfnServerPropsMixin.WorkflowDetailProperty