Skip to content
v2.277.0

CfnWorkflowProps Struct ​

Properties for defining a CfnWorkflow.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';

declare const copyStepDetails: any;
declare const customStepDetails: any;
declare const deleteStepDetails: any;
declare const tagStepDetails: any;
const cfnWorkflowProps: transfer.CfnWorkflowProps = {
  steps: [{
    copyStepDetails: copyStepDetails,
    customStepDetails: customStepDetails,
    decryptStepDetails: {
      destinationFileLocation: {
        efsFileLocation: {
          fileSystemId: 'fileSystemId',
          path: 'path',
        },
        s3FileLocation: {
          bucket: 'bucket',
          key: 'key',
        },
      },
      type: 'type',

      // the properties below are optional
      name: 'name',
      overwriteExisting: 'overwriteExisting',
      sourceFileLocation: 'sourceFileLocation',
    },
    deleteStepDetails: deleteStepDetails,
    tagStepDetails: tagStepDetails,
    type: 'type',
  }],

  // the properties below are optional
  description: 'description',
  onExceptionSteps: [{
    copyStepDetails: copyStepDetails,
    customStepDetails: customStepDetails,
    decryptStepDetails: {
      destinationFileLocation: {
        efsFileLocation: {
          fileSystemId: 'fileSystemId',
          path: 'path',
        },
        s3FileLocation: {
          bucket: 'bucket',
          key: 'key',
        },
      },
      type: 'type',

      // the properties below are optional
      name: 'name',
      overwriteExisting: 'overwriteExisting',
      sourceFileLocation: 'sourceFileLocation',
    },
    deleteStepDetails: deleteStepDetails,
    tagStepDetails: tagStepDetails,
    type: 'type',
  }],
  structuredLogDestinations: ['structuredLogDestinations'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transfer as transfer

# copy_step_details: Any
# custom_step_details: Any
# delete_step_details: Any
# tag_step_details: Any

cfn_workflow_props = transfer.CfnWorkflowProps(
    steps=[transfer.CfnWorkflow.WorkflowStepProperty(
        copy_step_details=copy_step_details,
        custom_step_details=custom_step_details,
        decrypt_step_details=transfer.CfnWorkflow.DecryptStepDetailsProperty(
            destination_file_location=transfer.CfnWorkflow.InputFileLocationProperty(
                efs_file_location=transfer.CfnWorkflow.EfsInputFileLocationProperty(
                    file_system_id="fileSystemId",
                    path="path"
                ),
                s3_file_location=transfer.CfnWorkflow.S3InputFileLocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            type="type",

            # the properties below are optional
            name="name",
            overwrite_existing="overwriteExisting",
            source_file_location="sourceFileLocation"
        ),
        delete_step_details=delete_step_details,
        tag_step_details=tag_step_details,
        type="type"
    )],

    # the properties below are optional
    description="description",
    on_exception_steps=[transfer.CfnWorkflow.WorkflowStepProperty(
        copy_step_details=copy_step_details,
        custom_step_details=custom_step_details,
        decrypt_step_details=transfer.CfnWorkflow.DecryptStepDetailsProperty(
            destination_file_location=transfer.CfnWorkflow.InputFileLocationProperty(
                efs_file_location=transfer.CfnWorkflow.EfsInputFileLocationProperty(
                    file_system_id="fileSystemId",
                    path="path"
                ),
                s3_file_location=transfer.CfnWorkflow.S3InputFileLocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            type="type",

            # the properties below are optional
            name="name",
            overwrite_existing="overwriteExisting",
            source_file_location="sourceFileLocation"
        ),
        delete_step_details=delete_step_details,
        tag_step_details=tag_step_details,
        type="type"
    )],
    structured_log_destinations=["structuredLogDestinations"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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()))
        .structuredLogDestinations(List.of("structuredLogDestinations"))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Transfer;

var copyStepDetails;
var customStepDetails;
var deleteStepDetails;
var tagStepDetails;

var cfnWorkflowProps = new CfnWorkflowProps {
    Steps = new [] { new WorkflowStepProperty {
        CopyStepDetails = copyStepDetails,
        CustomStepDetails = customStepDetails,
        DecryptStepDetails = new DecryptStepDetailsProperty {
            DestinationFileLocation = new InputFileLocationProperty {
                EfsFileLocation = new EfsInputFileLocationProperty {
                    FileSystemId = "fileSystemId",
                    Path = "path"
                },
                S3FileLocation = new S3InputFileLocationProperty {
                    Bucket = "bucket",
                    Key = "key"
                }
            },
            Type = "type",

            // the properties below are optional
            Name = "name",
            OverwriteExisting = "overwriteExisting",
            SourceFileLocation = "sourceFileLocation"
        },
        DeleteStepDetails = deleteStepDetails,
        TagStepDetails = tagStepDetails,
        Type = "type"
    } },

    // the properties below are optional
    Description = "description",
    OnExceptionSteps = new [] { new WorkflowStepProperty {
        CopyStepDetails = copyStepDetails,
        CustomStepDetails = customStepDetails,
        DecryptStepDetails = new DecryptStepDetailsProperty {
            DestinationFileLocation = new InputFileLocationProperty {
                EfsFileLocation = new EfsInputFileLocationProperty {
                    FileSystemId = "fileSystemId",
                    Path = "path"
                },
                S3FileLocation = new S3InputFileLocationProperty {
                    Bucket = "bucket",
                    Key = "key"
                }
            },
            Type = "type",

            // the properties below are optional
            Name = "name",
            OverwriteExisting = "overwriteExisting",
            SourceFileLocation = "sourceFileLocation"
        },
        DeleteStepDetails = deleteStepDetails,
        TagStepDetails = tagStepDetails,
        Type = "type"
    } },
    StructuredLogDestinations = new [] { "structuredLogDestinations" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var copyStepDetails interface{}
var customStepDetails interface{}
var deleteStepDetails interface{}
var tagStepDetails interface{}

cfnWorkflowProps := &CfnWorkflowProps{
	Steps: []interface{}{
		&WorkflowStepProperty{
			CopyStepDetails: copyStepDetails,
			CustomStepDetails: customStepDetails,
			DecryptStepDetails: &DecryptStepDetailsProperty{
				DestinationFileLocation: &InputFileLocationProperty{
					EfsFileLocation: &EfsInputFileLocationProperty{
						FileSystemId: jsii.String("fileSystemId"),
						Path: jsii.String("path"),
					},
					S3FileLocation: &S3InputFileLocationProperty{
						Bucket: jsii.String("bucket"),
						Key: jsii.String("key"),
					},
				},
				Type: jsii.String("type"),

				// the properties below are optional
				Name: jsii.String("name"),
				OverwriteExisting: jsii.String("overwriteExisting"),
				SourceFileLocation: jsii.String("sourceFileLocation"),
			},
			DeleteStepDetails: deleteStepDetails,
			TagStepDetails: tagStepDetails,
			Type: jsii.String("type"),
		},
	},

	// the properties below are optional
	Description: jsii.String("description"),
	OnExceptionSteps: []interface{}{
		&WorkflowStepProperty{
			CopyStepDetails: copyStepDetails,
			CustomStepDetails: customStepDetails,
			DecryptStepDetails: &DecryptStepDetailsProperty{
				DestinationFileLocation: &InputFileLocationProperty{
					EfsFileLocation: &EfsInputFileLocationProperty{
						FileSystemId: jsii.String("fileSystemId"),
						Path: jsii.String("path"),
					},
					S3FileLocation: &S3InputFileLocationProperty{
						Bucket: jsii.String("bucket"),
						Key: jsii.String("key"),
					},
				},
				Type: jsii.String("type"),

				// the properties below are optional
				Name: jsii.String("name"),
				OverwriteExisting: jsii.String("overwriteExisting"),
				SourceFileLocation: jsii.String("sourceFileLocation"),
			},
			DeleteStepDetails: deleteStepDetails,
			TagStepDetails: tagStepDetails,
			Type: jsii.String("type"),
		},
	},
	StructuredLogDestinations: []*string{
		jsii.String("structuredLogDestinations"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Specifies the text description for the workflow.
onExceptionStepsoptionalIResolvable | IResolvable | CfnWorkflow.WorkflowStepProperty[]on_exception_stepsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowStepProperty]]]onExceptionStepsoptionalIResolvableOnExceptionStepsoptionalIResolvableOnExceptionStepsoptionalinterface{}#
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
stepsIResolvable | IResolvable | CfnWorkflow.WorkflowStepProperty[]stepstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowStepProperty]]]stepsIResolvableStepsIResolvableStepsinterface{}required#
Specifies the details for the steps that are in the specified workflow.
structuredLogDestinationsoptionalstring[]structured_log_destinationsoptionaltyping.List[str]structuredLogDestinationsoptionalList<String>StructuredLogDestinationsoptionalstring[]StructuredLogDestinationsoptional*[]*string#
Specifies the log destinations for the workflow.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.