Fix : Added the endpoint type missing variable and update the README.md with new examples.

Author: anmolnagpal

README.md

@@ -66,22 +66,49 @@ This module has a few dependencies:
 
 
 ### 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.0"
-        name                      = "sftp"
-        environment               = "test"
-        label_order               = ["name", "environment"]
-        public_key                = ""
-        user_name                 = "ftp-user"
-        enable_sftp               = true
-        s3_bucket_id              = clouddrove_dev_s3_bucket
-        endpoint_type             = "PUBLIC"
+    module "sftp" {
+      source         = "clouddrove/sftp/aws"
+      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
+Here is an example of how you can use this module in your inventory structure:
+```hcl
+    module "sftp" {
+      source                 = "clouddrove/sftp/aws"
+      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"
+        }
+      }
+    }
+```
 
 
 

README.yaml

@@ -37,18 +37,45 @@ include:
 # 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.0"
-          name                      = "sftp"
-          environment               = "test"
-          label_order               = ["name", "environment"]
-          public_key                = ""
-          user_name                 = "ftp-user"
-          enable_sftp               = true
-          s3_bucket_id              = clouddrove_dev_s3_bucket
-          endpoint_type             = "PUBLIC"
-          }
+      source         = "clouddrove/sftp/aws"
+      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"
+      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"
+        }
+      }
+    }
+  ```

variables.tf

@@ -155,4 +155,10 @@ variable "workflow_details" {
 variable "enable_workflow" {
   type    = bool
   default = false
+}
+
+variable "endpoint_type" {
+  type        = string
+  default     = "PUBLIC"
+  description = "The type of endpoint that you want your SFTP server connect to. If you connect to a VPC (or VPC_ENDPOINT), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC. Defaults to PUBLIC"
 }