Skip to content

Commit cd4795b

Browse files
committed
update README.md
1 parent d638ec5 commit cd4795b

File tree

1 file changed

+36
-35
lines changed

1 file changed

+36
-35
lines changed

README.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -66,56 +66,56 @@ This module has a few dependencies:
6666

6767

6868
### Simple Example
69-
### Public
69+
### PUBLIC
7070
Here is an example of how you can use this module in your inventory structure:
7171
```hcl
72-
module "sftp" {
73-
source = "clouddrove/sftp/aws"
74-
version = "1.3.1"
75-
name = "sftp"
76-
environment = "test"
77-
label_order = ["environment", "name"]
78-
enable_sftp = true
79-
s3_bucket_name = module.s3_bucket.id
80-
endpoint_type = "PUBLIC"
81-
workflow_details = {
82-
on_upload = {
83-
execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
84-
workflow_id = "w-12345XXXX6da"
85-
}
72+
module "sftp" {
73+
source = "clouddrove/sftp/aws"
74+
version = "1.3.1"
75+
name = "sftp"
76+
environment = "test"
77+
label_order = ["environment", "name"]
78+
enable_sftp = true
79+
s3_bucket_name = module.s3_bucket.id
80+
endpoint_type = "PUBLIC"
81+
workflow_details = {
82+
on_upload = {
83+
execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
84+
workflow_id = "w-12345XXXX6da"
8685
}
8786
}
87+
}
8888
```
8989

90-
### VPC
91-
Here is an example of how you can use this module in your inventory structure:
90+
### VPC
9291
```hcl
93-
module "sftp" {
94-
source = "clouddrove/sftp/aws"
95-
version = "1.3.1"
96-
name = "sftp"
97-
environment = "test"
98-
label_order = ["environment", "name"]
99-
eip_enabled = false
100-
s3_bucket_name = module.s3_bucket.id
101-
sftp_users = var.sftp_users
102-
subnet_ids = module.subnets.private_subnet_id
103-
vpc_id = module.vpc.vpc_id
104-
restricted_home = true
105-
vpc_security_group_ids = [module.security_group_sftp.security_group_id]
106-
workflow_details = {
107-
on_upload = {
108-
execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
109-
workflow_id = "w-12345XXXX6da"
110-
}
92+
module "sftp" {
93+
source = "clouddrove/sftp/aws"
94+
version = "1.3.1"
95+
name = "sftp"
96+
environment = "test"
97+
label_order = ["environment", "name"]
98+
eip_enabled = false
99+
s3_bucket_name = module.s3_bucket.id
100+
sftp_users = var.sftp_users
101+
subnet_ids = module.subnets.private_subnet_id
102+
vpc_id = module.vpc.vpc_id
103+
restricted_home = true
104+
vpc_security_group_ids = [module.security_group_sftp.security_group_id]
105+
workflow_details = {
106+
on_upload = {
107+
execution_role = "arn:aws:iam::1234567890:role/test-sftp-transfer-role"
108+
workflow_id = "w-12345XXXX6da"
111109
}
112110
}
111+
}
113112
```
114113

115114

116115

117116

118117

118+
119119
## Inputs
120120

121121
| Name | Description | Type | Default | Required |
@@ -128,6 +128,7 @@ Here is an example of how you can use this module in your inventory structure:
128128
| enable\_sftp | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
129129
| enable\_workflow | n/a | `bool` | `false` | no |
130130
| enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
131+
| endpoint\_type | 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 | `string` | `"PUBLIC"` | no |
131132
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
132133
| force\_destroy | Forces the AWS Transfer Server to be destroyed | `bool` | `false` | no |
133134
| identity\_provider\_type | The mode of authentication enabled for this service. The default value is SERVICE\_MANAGED, which allows you to store and access SFTP user credentials within the service. API\_GATEWAY. | `string` | `"SERVICE_MANAGED"` | no |

0 commit comments

Comments
 (0)