README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name : Terraform AWS SFTP

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-sftp

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-sftp.svg"
    url: "https://github.com/clouddrove/terraform-aws-sftp/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  This terraform module is used to create sftp on AWS for S3.

# How to use this project
# How to use this project
usage : |-
  ### Simple Example
  ### PUBLIC  
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
    module "sftp" {
      source         = "clouddrove/sftp/aws"
      version        = "1.3.1"      
      name           = "sftp"
      environment    = "test"
      label_order    = ["environment", "name"]
      enable_sftp    = true
      s3_bucket_name = module.s3_bucket.id
      endpoint_type  = "PUBLIC"
      workflow_details = {
        on_upload = {
          execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
          workflow_id    = "w-12345XXXX6da"
        }
      }
    }
  ```

  ### VPC  
  ```hcl
    module "sftp" {
      source                 = "clouddrove/sftp/aws"
      version                = "1.3.1"      
      name                   = "sftp"
      environment            = "test"
      label_order            = ["environment", "name"]
      eip_enabled            = false
      s3_bucket_name         = module.s3_bucket.id
      sftp_users             = var.sftp_users
      subnet_ids             = module.subnets.private_subnet_id
      vpc_id                 = module.vpc.vpc_id
      restricted_home        = true
      vpc_security_group_ids = [module.security_group_sftp.security_group_id]
      workflow_details = {
        on_upload = {
          execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
          workflow_id    = "w-12345XXXX6da"
        }
      }
    }
  ```