Skip to content

Commit 102c3ec

Browse files
committed
docs: add readme for example
1 parent 35e5da5 commit 102c3ec

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

examples/complete/README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# Terraform Module Example
22

3-
## Complete
3+
## Complete Example
4+
5+
This directory provides a complete example of how to use the CloudFront
6+
Middleware-at-Edge module. This example deploys a simple static website using
7+
CloudFront and S3, with a Cognito User Pool for authentication and
8+
authorization. Lambda@Edge functions are deployed for URL rewriting and managing
9+
authentication.
10+
11+
### Usage
12+
13+
To run this example, provide your own values for the following variables in a
14+
`terraform.tfvars` file:
15+
16+
```hcl
17+
domain_name = "example.com"
18+
domain_parent_hosted_zone_id = "Z0123456789ABCDEFG"
19+
```
20+
21+
### Inputs
22+
23+
| Name | Description | Type | Default | Required |
24+
|------------------------------|--------------------------------------------------|:------:|:-------:|:--------:|
25+
| domain_name | The domain name for the CloudFront distribution. | string | n/a | yes |
26+
| domain_parent_hosted_zone_id | The ID of the parent hosted zone in Route 53. | string | n/a | yes |
27+
28+
### Outputs
29+
30+
| Name | Description |
31+
|------------------------|-------------------------------------------------|
32+
| website_domain_name | The domain name of the website. |
33+
| website_cf_domain_name | The domain name of the CloudFront distribution. |
34+
| test_user_credentials | The credentials of the test user. |

0 commit comments

Comments
 (0)