software.amazon.awscdk.services.transfer

Interface CfnWorkflow.CopyStepDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflow.CopyStepDetailsProperty.Jsii$Proxy

Enclosing class:

CfnWorkflow

@Stability(value=Stable)
public static interface CfnWorkflow.CopyStepDetailsProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CopyStepDetailsProperty copyStepDetailsProperty = CopyStepDetailsProperty.builder()
         .destinationFileLocation(S3FileLocationProperty.builder()
                 .s3FileLocation(S3InputFileLocationProperty.builder()
                         .bucket("bucket")
                         .key("key")
                         .build())
                 .build())
         .name("name")
         .overwriteExisting("overwriteExisting")
         .sourceFileLocation("sourceFileLocation")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWorkflow.CopyStepDetailsProperty.Builder A builder for CfnWorkflow.CopyStepDetailsProperty
static class	CfnWorkflow.CopyStepDetailsProperty.Jsii$Proxy An implementation for CfnWorkflow.CopyStepDetailsProperty

Method Summary

Modifier and Type	Method and Description
static CfnWorkflow.CopyStepDetailsProperty.Builder	builder()
default Object	getDestinationFileLocation() Specifies the location for the file being copied.
default String	getName() The name of the step, used as an identifier.
default String	getOverwriteExisting() A flag that indicates whether to overwrite an existing file of the same name.
default String	getSourceFileLocation() 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.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestinationFileLocation

@Stability(value=Stable)
 @Nullable
default Object getDestinationFileLocation()

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.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the step, used as an identifier.

getOverwriteExisting

@Stability(value=Stable)
 @Nullable
default String getOverwriteExisting()

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.

getSourceFileLocation

@Stability(value=Stable)
 @Nullable
default String getSourceFileLocation()

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} .

builder

@Stability(value=Stable)
static CfnWorkflow.CopyStepDetailsProperty.Builder builder()

Returns:

a CfnWorkflow.CopyStepDetailsProperty.Builder of CfnWorkflow.CopyStepDetailsProperty