Skip to content

Commit a3ef365

Browse files
committed
update README.md
1 parent 4451e09 commit a3ef365

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

README.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,14 @@
1313

1414
<p align="center">
1515

16-
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
18-
</a>
19-
<a href="LICENSE.md">
20-
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
16+
<a href="https://github.com/clouddrove/terraform-aws-sftp/releases/latest">
17+
<img src="https://img.shields.io/github/release/clouddrove/terraform-aws-sftp.svg" alt="Latest Release">
2118
</a>
2219
<a href="https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/tfsec.yml">
2320
<img src="https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
2421
</a>
25-
<a href="https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/terraform.yml">
26-
<img src="https://github.com/clouddrove/terraform-aws-sftp/actions/workflows/terraform.yml/badge.svg" alt="static-checks">
22+
<a href="LICENSE.md">
23+
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
2724
</a>
2825

2926

@@ -57,12 +54,6 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
5754

5855
This module has a few dependencies:
5956

60-
- [Terraform 1.x.x](https://learn.hashicorp.com/terraform/getting-started/install.html)
61-
- [Go](https://golang.org/doc/install)
62-
- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
63-
- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)
64-
65-
6657

6758

6859

@@ -79,11 +70,11 @@ Here is an example of how you can use this module in your inventory structure:
7970
```hcl
8071
module "sftp" {
8172
source = "clouddrove/sftp/aws"
82-
version = "0.15.0"
73+
version = "1.3.0"
8374
name = "sftp"
8475
environment = "test"
8576
label_order = ["name", "environment"]
86-
key_path = "~/.ssh/rsa"
77+
public_key = ""
8778
user_name = "ftp-user"
8879
enable_sftp = true
8980
s3_bucket_id = clouddrove_dev_s3_bucket
@@ -101,20 +92,17 @@ Here is an example of how you can use this module in your inventory structure:
10192
| Name | Description | Type | Default | Required |
10293
|------|-------------|------|---------|:--------:|
10394
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
104-
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
10595
| enable\_sftp | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
10696
| 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 |
10797
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
10898
| 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 |
109-
| key\_path | Name (e.g. `~/.ssh/id_rsa.pub`). | `string` | `""` | no |
11099
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
111100
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"[email protected]"` | no |
112101
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
113102
| public\_key | Name (e.g. `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | `string` | `""` | no |
114103
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-sftp"` | no |
115104
| s3\_bucket\_id | The landing directory (folder) for a user when they log in to the server using their SFTP client. | `string` | n/a | yes |
116105
| sub\_folder | Landind folder. | `string` | `""` | no |
117-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
118106
| user\_name | User name for SFTP server. | `string` | n/a | yes |
119107
| vpc\_id | VPC ID | `string` | `""` | no |
120108

0 commit comments

Comments
 (0)