-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.yaml
86 lines (78 loc) · 2.61 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
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Terraform AWS AMPLIFY
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-amplify
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove//terraform-aws-amplify.svg"
url: "https://github.com/clouddrove//terraform-aws-amplify/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-aws-amplify/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-aws-amplify/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.46.0"
module_dependencies:
- name: Labels Module
url: https://github.com/clouddrove/terraform-aws-labels
description: Provides resource tagging.
# description of this project
# yamllint disable rule:line-length
description: |-
Terraform module to provision AWS Amplify apps, backend environments, branches, domain associations, and webhooks.
# How to use this project
# yamllint disable rule:line-length
usage: |-
### Simple Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "amplify" {
source = "../"
name = "amplify"
environment = "test"
label_order = ["name", "environment"]
amplify_enabled = true
environment_name = "prod"
domain_name = ["newloop.eu", "newloop.dk"]
amplify_repository = "https://github.com/clouddrove-sandbox/terraform-aws-amplify"
access_token = "ghxxxxxm06Sd3KqkafBVu0xzcxcxcv0EA8AK"
amplify_branch_name = "main"
sub_domain_prefix_name = "scan"
deployment_artifacts = "app-example-deployment"
stack_name = "amplify-app-example"
branch_framework = "React"
branch_stage = "PRODUCTION"
branch_environment_variables = {
ENV = "test"
}
amplify_app_environment_variables = {
REACT_APP_API_SERVER = ""
}
custom_rules = [
{
source = "/01/<p01>/21/<p21>"
status = "302"
target = "/?p01=<p01>&p21=<p21> "
}
]
}
```