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

Interface CfnWorkflowMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflowMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.902Z")
@Stability(Stable)
public interface CfnWorkflowMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnWorkflowPropsMixin.

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.*;
 Object copyStepDetails;
 Object customStepDetails;
 Object deleteStepDetails;
 Object tagStepDetails;
 CfnWorkflowMixinProps cfnWorkflowMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkflowMixinProps.Builder	builder()
default String	getDescription()	Specifies the text description for the workflow.
default Object	getOnExceptionSteps()	Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
default Object	getSteps()	Specifies the details for the steps that are in the specified workflow.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for workflows.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

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

Specifies the text description for the workflow.

See Also:

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

getOnExceptionSteps

@Stability(Stable)
@Nullable
default 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 CfnWorkflowPropsMixin.WorkflowStepProperty>

See Also:

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

getSteps

@Stability(Stable)
@Nullable
default Object getSteps()

Specifies the details for the steps that are in the specified workflow.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.

See Also:

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

builder

@Stability(Stable)
static CfnWorkflowMixinProps.Builder builder()

Returns:

a CfnWorkflowMixinProps.Builder of CfnWorkflowMixinProps