Interface CopyStepDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CopyStepDetails.Builder,
,CopyStepDetails> SdkBuilder<CopyStepDetails.Builder,
,CopyStepDetails> SdkPojo
- Enclosing class:
CopyStepDetails
-
Method Summary
Modifier and TypeMethodDescriptiondefault CopyStepDetails.Builder
destinationFileLocation
(Consumer<InputFileLocation.Builder> destinationFileLocation) Specifies the location for the file being copied.destinationFileLocation
(InputFileLocation destinationFileLocation) Specifies the location for the file being copied.The name of the step, used as an identifier.overwriteExisting
(String overwriteExisting) A flag that indicates whether to overwrite an existing file of the same name.overwriteExisting
(OverwriteExisting overwriteExisting) A flag that indicates whether to overwrite an existing file of the same name.sourceFileLocation
(String 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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the step, used as an identifier.
- Parameters:
name
- The name of the step, used as an identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
destinationFileLocation
default CopyStepDetails.Builder destinationFileLocation(Consumer<InputFileLocation.Builder> 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.
InputFileLocation.Builder
avoiding the need to create one manually viaInputFileLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationFileLocation(InputFileLocation)
.- Parameters:
destinationFileLocation
- a consumer that will call methods onInputFileLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
- Parameters:
overwriteExisting
- A flag that indicates whether to overwrite an existing file of the same name. The default isFALSE
.If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
- Parameters:
overwriteExisting
- A flag that indicates whether to overwrite an existing file of the same name. The default isFALSE
.If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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}
.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-