generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.yaml
103 lines (85 loc) · 3.08 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
---
#
# 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 to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/terraform-aws-sftp-workflow.svg"
url: "https://github.com/clouddrove/terraform-aws-sftp-workflow/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-aws-sftp-workflow/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-aws-sftp-workflow/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.1"
providers:
- name: aws
url: https://aws.amazon.com/
version: ">= 5.21.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
usage : |-
### Simple Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "workflow1" {
source = "../"
name = "sftp-test-workflow"
environment = "test"
label_order = ["environment", "name"]
# workflow name
workflow_description = "Workflow-test1"
# delete step
enable_delete_step = true
delete_step_name = "delete-step-1"
# tag step
enable_tag_step = false
tag_step_name = "tag-step-1"
tag_key = "tag-key-1"
tag_value = "tag-value-1"
tag_step_source_location = "$${original.file}"
# custom step
enable_custom_step = false
custom_step_source_location = "$${original.file}"
timeout_seconds = 60
# copy step
enable_copy_step = true
copy_step_name = "example"
copy_overwrite_existing = "FALSE"
copy_step_source_location = "$${original.file}"
copy_bucket_name = "test-bucket"
copy_bucket_file_key = "destination_file.txt"
# decrypt step
enable_decrypt_step = false
decrypt_step_name = "decrypt-step-1"
decrypt_bucket_name = "test-bucket"
decrypt_bucket_file_key = "decrypted/file"
decrypt_overwrite_existing = "FALSE"
decrypt_step_source_location = "$${original.file}"
s3_bucket_id = module.s3_bucket.id
user_name = "test-user"
bucket_name = "test-bucket"
}
```