Package software.amazon.awscdk.services.transfer

Class CfnWorkflow

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnWorkflow
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkflowRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:31.650Z") @Stability(Stable) public class CfnWorkflow extends CfnResource implements IInspectable, IWorkflowRef, ITaggable
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

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.*;
 Object copyStepDetails;
 Object customStepDetails;
 Object deleteStepDetails;
 Object tagStepDetails;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .steps(List.of(WorkflowStepProperty.builder()
                 .copyStepDetails(copyStepDetails)
                 .customStepDetails(customStepDetails)
                 .decryptStepDetails(DecryptStepDetailsProperty.builder()
                         .destinationFileLocation(InputFileLocationProperty.builder()
                                 .efsFileLocation(EfsInputFileLocationProperty.builder()
                                         .fileSystemId("fileSystemId")
                                         .path("path")
                                         .build())
                                 .s3FileLocation(S3InputFileLocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build())
                         .type("type")
                         // the properties below are optional
                         .name("name")
                         .overwriteExisting("overwriteExisting")
                         .sourceFileLocation("sourceFileLocation")
                         .build())
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .build()))
         // the properties below are optional
         .description("description")
         .onExceptionSteps(List.of(WorkflowStepProperty.builder()
                 .copyStepDetails(copyStepDetails)
                 .customStepDetails(customStepDetails)
                 .decryptStepDetails(DecryptStepDetailsProperty.builder()
                         .destinationFileLocation(InputFileLocationProperty.builder()
                                 .efsFileLocation(EfsInputFileLocationProperty.builder()
                                         .fileSystemId("fileSystemId")
                                         .path("path")
                                         .build())
                                 .s3FileLocation(S3InputFileLocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build())
                         .type("type")
                         // the properties below are optional
                         .name("name")
                         .overwriteExisting("overwriteExisting")
                         .sourceFileLocation("sourceFileLocation")
                         .build())
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkflow

      @Stability(Stable) public CfnWorkflow(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkflowProps props)
      Create a new AWS::Transfer::Workflow.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForWorkflow

      @Stability(Stable) @NotNull public static String arnForWorkflow(@NotNull IWorkflowRef resource)
      Parameters:
      resource - This parameter is required.

    • fromWorkflowArn

      @Stability(Stable) @NotNull public static IWorkflowRef fromWorkflowArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IWorkflowRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromWorkflowId

      @Stability(Stable) @NotNull public static IWorkflowRef fromWorkflowId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String workflowId)
      Creates a new IWorkflowRef from a workflowId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      workflowId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Specifies the unique Amazon Resource Name (ARN) for the workflow.

    • getAttrWorkflowId

      @Stability(Stable) @NotNull public String getAttrWorkflowId()
      A unique identifier for a workflow.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWorkflowRef

      @Stability(Stable) @NotNull public WorkflowReference getWorkflowRef()
      A reference to a Workflow resource.
      Specified by:
      getWorkflowRef in interface IWorkflowRef

    • getSteps

      @Stability(Stable) @NotNull public Object getSteps()
      Specifies the details for the steps that are in the specified workflow.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkflow.WorkflowStepProperty>

    • setSteps

      @Stability(Stable) public void setSteps(@NotNull IResolvable value)
      Specifies the details for the steps that are in the specified workflow.

    • setSteps

      @Stability(Stable) public void setSteps(@NotNull List<Object> value)
      Specifies the details for the steps that are in the specified workflow.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Specifies the text description for the workflow.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Specifies the text description for the workflow.

    • getOnExceptionSteps

      @Stability(Stable) @Nullable public Object getOnExceptionSteps()
      Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkflow.WorkflowStepProperty>

    • setOnExceptionSteps

      @Stability(Stable) public void setOnExceptionSteps(@Nullable IResolvable value)
      Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

    • setOnExceptionSteps

      @Stability(Stable) public void setOnExceptionSteps(@Nullable List<Object> value)
      Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for workflows.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for workflows.