aws-cdk-lib.aws_transfer.CfnWorkflow.CopyStepDetailsProperty

CopyStepDetailsProperty Struct

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 .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const copyStepDetailsProperty: transfer.CfnWorkflow.CopyStepDetailsProperty = {
  destinationFileLocation: {
    s3FileLocation: {
      bucket: 'bucket',
      key: 'key',
    },
  },
  name: 'name',
  overwriteExisting: 'overwriteExisting',
  sourceFileLocation: 'sourceFileLocation',
};

Properties

destinationFileLocationIResolvable | CfnWorkflow.S3FileLocationPropertydestination_file_locationtyping.Union[IResolvable, S3FileLocationProperty]destinationFileLocationIResolvableDestinationFileLocationIResolvableDestinationFileLocationinterface{}#

Specifies the location for the file being copied.

notes

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.

namestringnamestrnameStringNamestringName*string#

The name of the step, used as an identifier.

overwriteExistingstringoverwrite_existingstroverwriteExistingStringOverwriteExistingstringOverwriteExisting*string#

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

notes

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.

sourceFileLocationstringsource_file_locationstrsourceFileLocationStringSourceFileLocationstringSourceFileLocation*string#

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.

notes

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