1.204.0

interface CopyStepDetailsProperty

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnWorkflow.CopyStepDetailsProperty
Javasoftware.amazon.awscdk.services.transfer.CfnWorkflow.CopyStepDetailsProperty
Pythonaws_cdk.aws_transfer.CfnWorkflow.CopyStepDetailsProperty
TypeScript @aws-cdk/aws-transfer » CfnWorkflow » CopyStepDetailsProperty

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 * as transfer from '@aws-cdk/aws-transfer';
const copyStepDetailsProperty: transfer.CfnWorkflow.CopyStepDetailsProperty = {
  destinationFileLocation: {
    s3FileLocation: {
      bucket: 'bucket',
      key: 'key',
    },
  },
  name: 'name',
  overwriteExisting: 'overwriteExisting',
  sourceFileLocation: 'sourceFileLocation',
};

Properties

NameTypeDescription
destinationFileLocation?IResolvable | S3FileLocationPropertySpecifies the location for the file being copied.
name?stringThe name of the step, used as an identifier.
overwriteExisting?stringA flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .
sourceFileLocation?stringSpecifies 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.

destinationFileLocation?

Type: IResolvable | S3FileLocationProperty (optional)

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.

name?

Type: string (optional)

The name of the step, used as an identifier.

overwriteExisting?

Type: string (optional)

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.

sourceFileLocation?

Type: string (optional)

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} .
← PreviousNext →