AWS::Transfer::Workflow DecryptStepDetails - AWS CloudFormation
SyntaxProperties

AWS::Transfer::Workflow DecryptStepDetails

Details for a step that decrypts an encrypted file.

Consists of the following values:

  • A descriptive name

  • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

  • An S3 or Amazon EFS location for the destination of the file decryption.

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

  • The type of encryption that's used. Currently, only PGP encryption is supported.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DestinationFileLocation" : InputFileLocation,
  "Name" : String,
  "OverwriteExisting" : String,
  "SourceFileLocation" : String,
  "Type" : String
}

Properties

DestinationFileLocation

Specifies the location for the file being decrypted. 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 decrypt 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 decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

    Note

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

Required: Yes

Type: InputFileLocation

Update requires: Replacement

Name

The name of the step, used as an identifier.

Required: No

Type: String

Pattern: ^[\w-]*$

Minimum: 0

Maximum: 30

Update requires: Replacement

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.

Required: No

Type: String

Allowed values: TRUE | FALSE

Update requires: Replacement

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

Required: No

Type: String

Pattern: ^\$\{(\w+.)+\w+\}$

Minimum: 0

Maximum: 256

Update requires: Replacement

Type

The type of encryption used. Currently, this value must be PGP.

Required: Yes

Type: String

Allowed values: PGP

Update requires: Replacement