Class: Aws::Transfer::Types::DecryptStepDetails

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_file_locationTypes::InputFileLocation

Specifies the location for the file being decrypted. 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 decrypt 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 decrypt 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.



1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1156

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

#nameString

The name of the step, used as an identifier.

Returns:

  • (String)


1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1156

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

#overwrite_existingString

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)


1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1156

class DecryptStepDetails < Struct.new(
  :name,
  :type,
  :source_file_location,
  :overwrite_existing,
  :destination_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.

  • 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)


1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1156

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

#typeString

The type of encryption used. Currently, this value must be PGP.

Returns:

  • (String)


1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1156

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