Package software.amazon.awssdk.services.transfer.model

Interface WorkflowStep.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkflowStep.Builder,WorkflowStep>, SdkBuilder<WorkflowStep.Builder,WorkflowStep>, SdkPojo
Enclosing class:
WorkflowStep
public static interface WorkflowStep.Builder extends SdkPojo, CopyableBuilder<WorkflowStep.Builder,WorkflowStep>

  • Method Details

    • type

      WorkflowStep.Builder type(String type)

      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.

      Parameters:
      type - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      WorkflowStep.Builder type(WorkflowStepType type)

      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.

      Parameters:
      type - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • copyStepDetails

      WorkflowStep.Builder copyStepDetails(CopyStepDetails 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • copyStepDetails

      default WorkflowStep.Builder copyStepDetails(Consumer<CopyStepDetails.Builder> 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.

      This is a convenience method that creates an instance of the CopyStepDetails.Builder avoiding the need to create one manually via CopyStepDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to copyStepDetails(CopyStepDetails).

      Parameters:
      copyStepDetails - a consumer that will call methods on CopyStepDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customStepDetails

      WorkflowStep.Builder customStepDetails(CustomStepDetails customStepDetails)

      Details for a step that invokes an Lambda function.

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

      Parameters:
      customStepDetails - Details for a step that invokes an Lambda function.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customStepDetails

      default WorkflowStep.Builder customStepDetails(Consumer<CustomStepDetails.Builder> customStepDetails)

      Details for a step that invokes an Lambda function.

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

      This is a convenience method that creates an instance of the CustomStepDetails.Builder avoiding the need to create one manually via CustomStepDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customStepDetails(CustomStepDetails).

      Parameters:
      customStepDetails - a consumer that will call methods on CustomStepDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deleteStepDetails

      WorkflowStep.Builder deleteStepDetails(DeleteStepDetails deleteStepDetails)

      Details for a step that deletes the file.

      Parameters:
      deleteStepDetails - Details for a step that deletes the file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteStepDetails

      default WorkflowStep.Builder deleteStepDetails(Consumer<DeleteStepDetails.Builder> deleteStepDetails)

      Details for a step that deletes the file.

      This is a convenience method that creates an instance of the DeleteStepDetails.Builder avoiding the need to create one manually via DeleteStepDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deleteStepDetails(DeleteStepDetails).

      Parameters:
      deleteStepDetails - a consumer that will call methods on DeleteStepDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagStepDetails

      WorkflowStep.Builder tagStepDetails(TagStepDetails tagStepDetails)

      Details for a step that creates one or more tags.

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tagStepDetails

      default WorkflowStep.Builder tagStepDetails(Consumer<TagStepDetails.Builder> tagStepDetails)

      Details for a step that creates one or more tags.

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

      This is a convenience method that creates an instance of the TagStepDetails.Builder avoiding the need to create one manually via TagStepDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagStepDetails(TagStepDetails).

      Parameters:
      tagStepDetails - a consumer that will call methods on TagStepDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • decryptStepDetails

      WorkflowStep.Builder decryptStepDetails(DecryptStepDetails 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • decryptStepDetails

      default WorkflowStep.Builder decryptStepDetails(Consumer<DecryptStepDetails.Builder> 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.

      This is a convenience method that creates an instance of the DecryptStepDetails.Builder avoiding the need to create one manually via DecryptStepDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to decryptStepDetails(DecryptStepDetails).

      Parameters:
      decryptStepDetails - a consumer that will call methods on DecryptStepDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: