Package software.amazon.awscdk.services.transfer

Class CfnWorkflow.CopyStepDetailsProperty.Builder

java.lang.Object
software.amazon.awscdk.services.transfer.CfnWorkflow.CopyStepDetailsProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkflow.CopyStepDetailsProperty>
Enclosing interface:
CfnWorkflow.CopyStepDetailsProperty
@Stability(Stable) public static final class CfnWorkflow.CopyStepDetailsProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnWorkflow.CopyStepDetailsProperty>
A builder for CfnWorkflow.CopyStepDetailsProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • destinationFileLocation

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty.Builder destinationFileLocation(IResolvable destinationFileLocation)
      Sets the value of CfnWorkflow.CopyStepDetailsProperty.getDestinationFileLocation()
      Parameters:
      destinationFileLocation - 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:
      this

    • destinationFileLocation

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty.Builder destinationFileLocation(CfnWorkflow.S3FileLocationProperty destinationFileLocation)
      Sets the value of CfnWorkflow.CopyStepDetailsProperty.getDestinationFileLocation()
      Parameters:
      destinationFileLocation - 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:
      this

    • name

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty.Builder name(String name)
      Sets the value of CfnWorkflow.CopyStepDetailsProperty.getName()
      Parameters:
      name - The name of the step, used as an identifier.
      Returns:
      this

    • overwriteExisting

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty.Builder overwriteExisting(String overwriteExisting)
      Sets the value of CfnWorkflow.CopyStepDetailsProperty.getOverwriteExisting()
      Parameters:
      overwriteExisting - 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:
      this

    • sourceFileLocation

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty.Builder sourceFileLocation(String sourceFileLocation)
      Sets the value of CfnWorkflow.CopyStepDetailsProperty.getSourceFileLocation()
      Parameters:
      sourceFileLocation - 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:
      this

    • build

      @Stability(Stable) public CfnWorkflow.CopyStepDetailsProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWorkflow.CopyStepDetailsProperty>
      Returns:
      a new instance of CfnWorkflow.CopyStepDetailsProperty
      Throws:
      NullPointerException - if any required attribute was not provided