New resource: aws_transfer_workflow

[davidferguson-cr]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

AWS released a new feature for AWS Transfer Family that adds support for managed workflows to make it easy to create, execute, and monitor post upload processing for file transfers over SFTP, FTPS, and FTP for Amazon S3 and Amazon EFS.

New or Affected Resource(s)

• aws_transfer_workflow (new resource): creates a workflow with specified steps and step details that the workflow invokes after a file transfer completes.
• aws_transfer_server (affected resource): requires new workflow_details argument to enable a workflow to be associated with a server. Only supports a single on_upload workflow detail currently which will contain the workflow ID for the workflow to be associated and an execution IAM role for the workflow to run as.
• aws_transfer_workflow (new data source): data source to get the ID of an AWS Transfer Workflow for use in other resources.

Potential Terraform Configuration

Resources

resource "aws_transfer_server" "example" {
  endpoint_type = "PUBLIC"
  protocols     = ["SFTP"]
  domain        = "S3"

  workflow_details {
    on_upload = [
      {
        execution_role_arn = aws_iam_role.iam_for_transfer.arn
        workflow_id        = aws_transfer_workflow.example.id
      }
    ]
  }
}

resource "aws_transfer_workflow" "example" {
  description = "Example workflow description"

  steps = [
    {
      # Array of workflow steps as per
      # https://docs.aws.amazon.com/transfer/latest/userguide/API_WorkflowStep.html
    }
  ]

  on_exception_steps = [
    {
      # Array of workflow steps as per
      # https://docs.aws.amazon.com/transfer/latest/userguide/API_WorkflowStep.html
    }
  ]

  tags = {
    Name = "Example workflow"
  }
}

resource "aws_iam_role" "iam_for_transfer" {
  name = "iam_for_transfer"

  assume_role_policy = <<EOF
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "transfer.amazonaws.com"
      }
    }
  ]
}
EOF
}

# Note: aws_iam_policy and aws_iam_role_policy_attachment omitted for brevity

Data Source

data "aws_transfer_workflow" "example" {
  workflow_id = "w-12345678901234567"
}

Requires

• build(deps): bump github.com/aws/aws-sdk-go from 1.40.35 to 1.40.37 #20804

References

• AWS Announcement: https://aws.amazon.com/about-aws/whats-new/2021/09/aws-transfer-family-managed-workflows/
• User Guide: https://docs.aws.amazon.com/transfer/latest/userguide/transfer-workflows.html
• Relevant AWS Transfer Family API Actions:
  • CreateWorkflow: https://docs.aws.amazon.com/transfer/latest/userguide/API_CreateWorkflow.html
  • DeleteWorkflow: https://docs.aws.amazon.com/transfer/latest/userguide/API_DeleteWorkflow.html
  • DescribeWorkflow: https://docs.aws.amazon.com/transfer/latest/userguide/API_DescribeWorkflow.html
  • ListWorkflows: https://docs.aws.amazon.com/transfer/latest/userguide/API_ListWorkflows.html
  • CreateServer: https://docs.aws.amazon.com/transfer/latest/userguide/API_CreateServer.html
  • UpdateServer: https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html

[github-actions]

This functionality has been released in v4.11.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.