workflows

Creates, updates, deletes or gets a workflow resource or lists workflows in a region

Overview

Name	workflows
Type	Resource
Description	Resource Type definition for AWS::Transfer::Workflow
Id	aws.transfer.workflows

Fields

Name	Datatype	Description
on_exception_steps	array	Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
steps	array	Specifies the details for the steps that are in the specified workflow.
tags	array	Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
description	string	A textual description for the workflow.
workflow_id	string	A unique identifier for the workflow.
arn	string	Specifies the unique Amazon Resource Name (ARN) for the workflow.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Steps, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all workflows in a region.

SELECT
region,
on_exception_steps,
steps,
tags,
description,
workflow_id,
arn
FROM aws.transfer.workflows
WHERE region = 'us-east-1';

Gets all properties from an individual workflow.

SELECT
region,
on_exception_steps,
steps,
tags,
description,
workflow_id,
arn
FROM aws.transfer.workflows
WHERE region = 'us-east-1' AND data__Identifier = '<WorkflowId>';

INSERT example

Use the following StackQL query and manifest file to create a new workflow resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.transfer.workflows (
 Steps,
 region
)
SELECT 
'{{ Steps }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.transfer.workflows (
 OnExceptionSteps,
 Steps,
 Tags,
 Description,
 region
)
SELECT 
 '{{ OnExceptionSteps }}',
 '{{ Steps }}',
 '{{ Tags }}',
 '{{ Description }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: workflow
    props:
      - name: OnExceptionSteps
        value:
          - CopyStepDetails:
              DestinationFileLocation:
                S3FileLocation:
                  Bucket: '{{ Bucket }}'
                  Key: '{{ Key }}'
              Name: '{{ Name }}'
              OverwriteExisting: '{{ OverwriteExisting }}'
              SourceFileLocation: '{{ SourceFileLocation }}'
            CustomStepDetails:
              Name: '{{ Name }}'
              Target: '{{ Target }}'
              TimeoutSeconds: '{{ TimeoutSeconds }}'
              SourceFileLocation: '{{ SourceFileLocation }}'
            DecryptStepDetails:
              DestinationFileLocation:
                S3FileLocation: null
                EfsFileLocation:
                  FileSystemId: '{{ FileSystemId }}'
                  Path: '{{ Path }}'
              Name: '{{ Name }}'
              Type: '{{ Type }}'
              OverwriteExisting: '{{ OverwriteExisting }}'
              SourceFileLocation: '{{ SourceFileLocation }}'
            DeleteStepDetails:
              Name: '{{ Name }}'
              SourceFileLocation: '{{ SourceFileLocation }}'
            TagStepDetails:
              Name: '{{ Name }}'
              Tags:
                - Key: '{{ Key }}'
                  Value: '{{ Value }}'
              SourceFileLocation: '{{ SourceFileLocation }}'
            Type: '{{ Type }}'
      - name: Steps
        value:
          - null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Description
        value: '{{ Description }}'

DELETE example

/*+ delete */
DELETE FROM aws.transfer.workflows
WHERE data__Identifier = '<WorkflowId>'
AND region = 'us-east-1';

Permissions

To operate on the workflows resource, the following permissions are required:

Create

transfer:CreateWorkflow,
transfer:TagResource

Read

transfer:DescribeWorkflow

Delete

transfer:DeleteWorkflow

List

transfer:ListWorkflows

Update

transfer:UnTagResource,
transfer:TagResource