Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-transfer-workflow.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Transfer::Workflow. Source:- No source definition found, add manually please

Properties

Steps WorkflowStep[] required

Specifies the details for the steps that are in the specified workflow.

maxItems=8uniqueItems=true
OnExceptionSteps WorkflowStep[]

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

maxItems=8uniqueItems=true
Tags Tag[]

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

maxItems=50uniqueItems=true
Description string | Aws_CF_FunctionString

A textual description for the workflow.

Definitions

S3Tag object

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

Key string | Aws_CF_FunctionString required

The name assigned to the tag that you create.

Value string | Aws_CF_FunctionString required

The value that corresponds to the key.

EfsInputFileLocation object

Specifies the details for an EFS file.

FileSystemId string | Aws_CF_FunctionString

Specifies the EFS filesystem that contains the file.

Path string | Aws_CF_FunctionString

The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.

S3InputFileLocation object

Specifies the details for a S3 file.

Bucket string | Aws_CF_FunctionString

Specifies the S3 bucket that contains the file.

Key string | Aws_CF_FunctionString

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

InputFileLocation object

Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps.

S3FileLocation object

Specifies the details for a S3 file.

2 nested properties
Bucket string | Aws_CF_FunctionString

Specifies the S3 bucket that contains the file.

Key string | Aws_CF_FunctionString

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

EfsFileLocation object

Specifies the details for an EFS file.

2 nested properties
FileSystemId string | Aws_CF_FunctionString

Specifies the EFS filesystem that contains the file.

Path string | Aws_CF_FunctionString

The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.

S3FileLocation object

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

S3FileLocation object

Specifies the details for a S3 file.

2 nested properties
Bucket string | Aws_CF_FunctionString

Specifies the S3 bucket that contains the file.

Key string | Aws_CF_FunctionString

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

WorkflowStep object

The basic building block of a workflow.

CopyStepDetails object

Details for a step that performs a file copy.

4 nested properties
DestinationFileLocation object

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

1 nested properties
S3FileLocation object

Specifies the details for a S3 file.

Name string | Aws_CF_FunctionString

The name of the step, used as an identifier.

OverwriteExisting string | Aws_CF_FunctionString

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

SourceFileLocation string | Aws_CF_FunctionString

Specifies which file to use as input to the workflow step.

CustomStepDetails object

Details for a step that invokes a lambda function.

4 nested properties
Name string | Aws_CF_FunctionString

The name of the step, used as an identifier.

Target string | Aws_CF_FunctionString

The ARN for the lambda function that is being called.

TimeoutSeconds integer

Timeout, in seconds, for the step.

min=1max=1800
SourceFileLocation string | Aws_CF_FunctionString

Specifies which file to use as input to the workflow step.

DecryptStepDetails object

Details for a step that performs a file decryption.

5 nested properties
DestinationFileLocation object

Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps.

2 nested properties
S3FileLocation object

Specifies the details for a S3 file.

EfsFileLocation object

Specifies the details for an EFS file.

Name string | Aws_CF_FunctionString

The name of the step, used as an identifier.

Type string | Aws_CF_FunctionString

Specifies which encryption method to use.

OverwriteExisting string | Aws_CF_FunctionString

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

SourceFileLocation string | Aws_CF_FunctionString

Specifies which file to use as input to the workflow step.

DeleteStepDetails object

Details for a step that deletes the file.

2 nested properties
Name string | Aws_CF_FunctionString

The name of the step, used as an identifier.

SourceFileLocation string | Aws_CF_FunctionString

Specifies which file to use as input to the workflow step.

TagStepDetails object

Details for a step that creates one or more tags.

3 nested properties
Name string | Aws_CF_FunctionString

The name of the step, used as an identifier.

Tags S3Tag[]

Array that contains from 1 to 10 key/value pairs.

maxItems=10uniqueItems=true
SourceFileLocation string | Aws_CF_FunctionString

Specifies which file to use as input to the workflow step.

Type string | Aws_CF_FunctionString
Tag object

Creates a key-value pair for a specific resource.

Key string | Aws_CF_FunctionString required

The name assigned to the tag that you create.

Value string | Aws_CF_FunctionString required

Contains one or more values that you assigned to the key name you create.