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

Class CfnWorkflowPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnWorkflowPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.903Z")
@Stability(Stable)
public class CfnWorkflowPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.transfer.*;
 import software.amazon.awscdk.*;
 Object copyStepDetails;
 Object customStepDetails;
 Object deleteStepDetails;
 IMergeStrategy mergeStrategy;
 Object tagStepDetails;
 CfnWorkflowPropsMixin cfnWorkflowPropsMixin = CfnWorkflowPropsMixin.Builder.create(CfnWorkflowMixinProps.builder()
         .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())
                         .name("name")
                         .overwriteExisting("overwriteExisting")
                         .sourceFileLocation("sourceFileLocation")
                         .type("type")
                         .build())
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .build()))
         .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())
                         .name("name")
                         .overwriteExisting("overwriteExisting")
                         .sourceFileLocation("sourceFileLocation")
                         .type("type")
                         .build())
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnWorkflowPropsMixin.Builder	A fluent builder for CfnWorkflowPropsMixin.
static interface	CfnWorkflowPropsMixin.DecryptStepDetailsProperty	Details for a step that decrypts an encrypted file.
static interface	CfnWorkflowPropsMixin.EfsInputFileLocationProperty	Specifies the Amazon EFS identifier and the path for the file being used.
static interface	CfnWorkflowPropsMixin.InputFileLocationProperty	Specifies the location for the file that's being processed.
static interface	CfnWorkflowPropsMixin.S3InputFileLocationProperty	Specifies the details for the Amazon S3 location for an input file to a workflow.
static interface	CfnWorkflowPropsMixin.WorkflowStepProperty	The basic building block of a workflow.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnWorkflowPropsMixin(CfnWorkflowMixinProps props)	Create a mixin to apply properties to AWS::Transfer::Workflow.
	CfnWorkflowPropsMixin(CfnWorkflowMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Transfer::Workflow.
protected	CfnWorkflowPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkflowPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnWorkflowMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnWorkflowPropsMixin

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

CfnWorkflowPropsMixin

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

CfnWorkflowPropsMixin

@Stability(Stable)
public CfnWorkflowPropsMixin(@NotNull
 CfnWorkflowMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Transfer::Workflow.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnWorkflowPropsMixin

@Stability(Stable)
public CfnWorkflowPropsMixin(@NotNull
 CfnWorkflowMixinProps props)

Create a mixin to apply properties to AWS::Transfer::Workflow.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnWorkflowMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()