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

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

Overview

The basic building block of a workflow.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_step_details ⇒ Types::CopyStepDetails

Details for a step that performs a file copy.

Consists of the following values:

  • A description

  • An Amazon S3 location for the destination of the file copy.

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

Returns:



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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

#custom_step_details ⇒ Types::CustomStepDetails

Details for a step that invokes an Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

Returns:



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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

#decrypt_step_details ⇒ Types::DecryptStepDetails

Details for a step that decrypts an encrypted file.

Consists of the following values:

  • A descriptive name

  • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

  • An S3 or Amazon EFS location for the destination of the file decryption.

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

  • The type of encryption that's used. Currently, only PGP encryption is supported.

Returns:



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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

#delete_step_details ⇒ Types::DeleteStepDetails

Details for a step that deletes the file.

Returns:



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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

#tag_step_details ⇒ Types::TagStepDetails

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

Returns:



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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

#type ⇒ String

Currently, the following step types are supported.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

Returns:

  • (String) 


7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7661

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