AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Transfer::Types::WorkflowStep

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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
      },
    ],
  },
}

The basic building block of a workflow.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_step_detailsTypes::CopyStepDetails

Details for a step that performs a file copy.

Consists of the following values:

  • A description

  • An S3 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.



4349
4350
4351
4352
4353
4354
4355
4356
4357
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4349

class WorkflowStep < Struct.new(
  :type,
  :copy_step_details,
  :custom_step_details,
  :delete_step_details,
  :tag_step_details)
  SENSITIVE = []
  include Aws::Structure
end

#custom_step_detailsTypes::CustomStepDetails

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).



4349
4350
4351
4352
4353
4354
4355
4356
4357
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4349

class WorkflowStep < Struct.new(
  :type,
  :copy_step_details,
  :custom_step_details,
  :delete_step_details,
  :tag_step_details)
  SENSITIVE = []
  include Aws::Structure
end

#delete_step_detailsTypes::DeleteStepDetails

Details for a step that deletes the file.



4349
4350
4351
4352
4353
4354
4355
4356
4357
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4349

class WorkflowStep < Struct.new(
  :type,
  :copy_step_details,
  :custom_step_details,
  :delete_step_details,
  :tag_step_details)
  SENSITIVE = []
  include Aws::Structure
end

#tag_step_detailsTypes::TagStepDetails

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.



4349
4350
4351
4352
4353
4354
4355
4356
4357
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4349

class WorkflowStep < Struct.new(
  :type,
  :copy_step_details,
  :custom_step_details,
  :delete_step_details,
  :tag_step_details)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


4349
4350
4351
4352
4353
4354
4355
4356
4357
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4349

class WorkflowStep < Struct.new(
  :type,
  :copy_step_details,
  :custom_step_details,
  :delete_step_details,
  :tag_step_details)
  SENSITIVE = []
  include Aws::Structure
end