Interface CfnWorkflowProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkflowProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:48.582Z")
@Stability(Stable)
public interface CfnWorkflowProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnWorkflow.
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;
CfnWorkflowProps cfnWorkflowProps = CfnWorkflowProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnWorkflowPropsstatic final classAn implementation forCfnWorkflowProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnWorkflowProps.Builderbuilder()default StringSpecifies the text description for the workflow.default ObjectSpecifies the steps (actions) to take if errors are encountered during execution of the workflow.getSteps()Specifies the details for the steps that are in the specified workflow.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
-
getSteps
Specifies the details for the steps that are in the specified workflow.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnWorkflow.WorkflowStepProperty>- See Also:
-
getDescription
Specifies the text description for the workflow.- See Also:
-
getOnExceptionSteps
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnWorkflow.WorkflowStepProperty>- See Also:
-
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:
-
builder
- Returns:
- a
CfnWorkflowProps.BuilderofCfnWorkflowProps
-