Skip to content
v2.277.0

WorkflowStepProperty Struct ​

The basic building block of a workflow.

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 workflowStepProperty: transfer.CfnWorkflow.WorkflowStepProperty = {
  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',
};
python
# 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

workflow_step_property = 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"
)
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;

WorkflowStepProperty workflowStepProperty = 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();
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 workflowStepProperty = 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"
};
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{}

workflowStepProperty := &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"),
}

Properties ​

copyStepDetailsoptionalanycopy_step_detailsoptionalAnycopyStepDetailsoptionalObjectCopyStepDetailsoptionalobjectCopyStepDetailsoptionalinterface{}#
Details for a step that performs a file copy.

Consists of the following values:

  • A description
  • An Amazon S3 location for the destination of the file copy.
  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .
customStepDetailsoptionalanycustom_step_detailsoptionalAnycustomStepDetailsoptionalObjectCustomStepDetailsoptionalobjectCustomStepDetailsoptionalinterface{}#
Details for a step that invokes an AWS Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

decryptStepDetailsoptionalIResolvable | CfnWorkflow.DecryptStepDetailsPropertydecrypt_step_detailsoptionaltyping.Union[IResolvable, DecryptStepDetailsProperty]decryptStepDetailsoptionalIResolvableDecryptStepDetailsoptionalIResolvableDecryptStepDetailsoptionalinterface{}#
Details for a step that decrypts an encrypted file.
notes

Consists of the following values:

  • A descriptive name
  • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
  • An S3 or Amazon EFS location for the destination of the file decryption.
  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .
  • The type of encryption that's used. Currently, only PGP encryption is supported.
deleteStepDetailsoptionalanydelete_step_detailsoptionalAnydeleteStepDetailsoptionalObjectDeleteStepDetailsoptionalobjectDeleteStepDetailsoptionalinterface{}#
Details for a step that deletes the file.
tagStepDetailsoptionalanytag_step_detailsoptionalAnytagStepDetailsoptionalObjectTagStepDetailsoptionalobjectTagStepDetailsoptionalinterface{}#
Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string#
Currently, the following step types are supported.
notes
  • COPY - Copy the file to another location.
  • CUSTOM - Perform a custom step with an AWS Lambda function target.
  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.
  • DELETE - Delete the file.
  • TAG - Add a tag to the file.