Class: Aws::Transfer::Types::CopyStepDetails

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 CopyStepDetails data as a hash:

{
  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
  source_file_location: "SourceFileLocation",
}

Each step type has its own StepDetails structure.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_file_locationTypes::InputFileLocation

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use $\{Transfer:username\} in this field to parametrize the destination prefix by username.



166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 166

class CopyStepDetails < Struct.new(
  :name,
  :destination_file_location,
  :overwrite_existing,
  :source_file_location)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the step, used as an identifier.

Returns:

  • (String)


166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 166

class CopyStepDetails < Struct.new(
  :name,
  :destination_file_location,
  :overwrite_existing,
  :source_file_location)
  SENSITIVE = []
  include Aws::Structure
end

#overwrite_existingString

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

Returns:

  • (String)


166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 166

class CopyStepDetails < Struct.new(
  :name,
  :destination_file_location,
  :overwrite_existing,
  :source_file_location)
  SENSITIVE = []
  include Aws::Structure
end

#source_file_locationString

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter $\{previous.file\} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • Enter $\{original.file\} to use the originally-uploaded file location as input for this step.

Returns:

  • (String)


166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 166

class CopyStepDetails < Struct.new(
  :name,
  :destination_file_location,
  :overwrite_existing,
  :source_file_location)
  SENSITIVE = []
  include Aws::Structure
end