class Aws::Transfer::Types::WorkflowStep
The basic building block of a workflow.
@note When making an API call, you may pass WorkflowStep
data as a hash: { type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE copy_step_details: { name: "WorkflowStepName", destination_file_location: { s3_file_location: { bucket: "S3Bucket", key: "S3Key", }, efs_file_location: { file_system_id: "EfsFileSystemId", path: "EfsPath", }, }, overwrite_existing: "TRUE", # accepts TRUE, FALSE }, custom_step_details: { name: "WorkflowStepName", target: "CustomStepTarget", timeout_seconds: 1, }, delete_step_details: { name: "WorkflowStepName", }, tag_step_details: { name: "WorkflowStepName", tags: [ { key: "S3TagKey", # required value: "S3TagValue", # required }, ], }, }
@!attribute [rw] type
Currently, the following step types are supported. * *Copy*\: copy the file to another location * *Custom*\: custom step with a lambda target * *Delete*\: delete the file * *Tag*\: add a tag to the file @return [String]
@!attribute [rw] copy_step_details
Details for a step that performs a file copy. Consists of the following values: * A description * An S3 or EFS location for the destination of the file copy. * A flag that indicates whether or not to overwrite an existing file of the same name. The default is `FALSE`. @return [Types::CopyStepDetails]
@!attribute [rw] custom_step_details
Details for a step that invokes a lambda function. Consists of the lambda function name, target, and timeout (in seconds). @return [Types::CustomStepDetails]
@!attribute [rw] delete_step_details
You need to specify the name of the file to be deleted. @return [Types::DeleteStepDetails]
@!attribute [rw] tag_step_details
Details for a step that creates one or more tags. You specify one or more tags: each tag contains a key/value pair. @return [Types::TagStepDetails]
@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowStep AWS API Documentation
Constants
- SENSITIVE