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

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

Overview

Each step type has its own StepDetails structure.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_file_location ⇒ Types::InputFileLocation

Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

  • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

  • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

Returns:



250
251
252
253
254
255
256
257
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 250

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

#name ⇒ String

The name of the step, used as an identifier.

Returns:

  • (String) 


250
251
252
253
254
255
256
257
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 250

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

#overwrite_existing ⇒ String

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

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

  • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

  • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

Returns:

  • (String) 


250
251
252
253
254
255
256
257
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 250

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

#source_file_location ⇒ String

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.

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

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

Returns:

  • (String) 


250
251
252
253
254
255
256
257
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 250

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