Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paliwalvimal committed May 3, 2021
1 parent 039ca90 commit 356fa27
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ module "website" {
| default_root_object | The object that you want CloudFront to return when an end user requests the root URL | `string` | `"index.html"` | no |
| cnames | Access CloudFront using alternate domain names, if any | `list(string)` | `[]` | no |
| web_acl_id | For ACL created via WAFv2 provide ACL ARN and for ACL created via WAFv1 provide ACL Id | `string` | `null` | no |
| lambda_functions | A config block that triggers a lambda function with specific actions (maximum 4)<pre>{<br> event_type = The specific event to trigger this function. Possible values: viewer-request, origin-request, viewer-response, origin-response<br> lambda_arn = ARN of the Lambda function to trigger upon certain event<br> include_body = When set to true it exposes the request body to the lambda function. Required ONLY for request event. Defaults to false<br>}</pre> | <pre>list(object({<br> event_type = string<br> lambda_arn = string<br> include_body = bool<br> }))</pre> | <pre>[<br> {<br> "include_body": null<br> }<br>]</pre> | no |
| lambda_functions | A config block that triggers a lambda function with specific actions (maximum 4)<pre>{<br> event_type = The specific event to trigger this function. Possible values: viewer-request, origin-request, viewer-response, origin-response<br> lambda_arn = ARN of the Lambda function to trigger upon certain event<br> include_body = When set to true it exposes the request body to the lambda function. Required ONLY for request event<br>}</pre> | <pre>list(object({<br> event_type = string<br> lambda_arn = string<br> include_body = optional(bool)<br> }))</pre> | `[]` | no |
| price_class | The price class for this distribution. Possible Values: PriceClass_All, PriceClass_200, PriceClass_100 | `string` | `"PriceClass_All"` | no |
| ssl_support_method | Specifies how you want CloudFront to serve HTTPS requests. Required if using custom certificate. Possible Values: vip or sni-only | `string` | `"sni-only"` | no |
| ssl_cert_protocol_version | The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections. Required if using custom certificate. Possible Values: SSLv3, TLSv1, TLSv1_2016, TLSv1.1_2016, TLSv1.2_2018 or TLSv1.2_2019 | `string` | `"TLSv1.2_2019"` | no |
| geo_restriction_type | The method that you want to use to restrict distribution of your content by country. Possible Values: none, whitelist, or blacklist | `string` | `"none"` | no |
| geo_restriction_locations | The `ISO 3166-1-alpha-2` country codes for which you to either whitelist or blacklist CloudFront content | `list(string)` | `[]` | no |
| custom_error_responses | One or more custom error response elements (multiples allowed)<pre>{<br> error_caching_min_ttl = The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated<br> error_code = The 4xx or 5xx HTTP status code that you want to customize<br> response_code = The HTTP status code that you want CloudFront to return with the custom error page to the viewer<br> response_page_path = The path of the custom error page. Example: /404.html. Make sure the file 404.html is present within the origin<br>}</pre> | <pre>list(object({<br> error_caching_min_ttl = number<br> error_code = number<br> response_code = number<br> response_page_path = string<br> }))</pre> | <pre>[<br> {<br> "error_caching_min_ttl": null,<br> "response_code": null,<br> "response_page_path": null<br> }<br>]</pre> | no |
| access_logging | The logging configuration that controls how logs are written to your distribution<pre>{<br> bucket = The Amazon S3 bucket to store the access logs in. Example: bucketname.s3.amazonaws.com<br> include_cookies = Specifies whether you want CloudFront to include cookies in access logs<br> prefix = An optional string that you want CloudFront to prefix to the access log filenames for this distribution<br>}</pre> | <pre>object({<br> bucket = string<br> include_cookies = bool<br> prefix = string<br> })</pre> | <pre>{<br> "include_cookies": false,<br> "prefix": null<br>}</pre> | no |
| custom_error_responses | One or more custom error response elements (multiples allowed)<pre>{<br> error_caching_min_ttl = The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated<br> error_code = The 4xx or 5xx HTTP status code that you want to customize<br> response_code = The HTTP status code that you want CloudFront to return with the custom error page to the viewer<br> response_page_path = The path of the custom error page. Example: /404.html. Make sure the file 404.html is present within the origin<br>}</pre> | <pre>list(object({<br> error_code = number<br> error_caching_min_ttl = optional(number)<br> response_code = optional(number)<br> response_page_path = optional(string)<br> }))</pre> | `[]` | no |
| access_logging | The logging configuration that controls how logs are written to your distribution<pre>{<br> bucket = The Amazon S3 bucket to store the access logs in. Example: bucketname.s3.amazonaws.com<br> include_cookies = Specifies whether you want CloudFront to include cookies in access logs<br> prefix = An optional string that you want CloudFront to prefix to the access log filenames for this distribution<br>}</pre> | <pre>object({<br> bucket = string<br> include_cookies = optional(bool)<br> prefix = optional(string)<br> })</pre> | `null` | no |
| tags | Key Value pair to assign to CloudFront and S3 bucket | `map(any)` | `{}` | no |
| comment | Description/Comments about distribution | `string` | `"Managed by terrablocks"` | no |
| hosted_zone | Name of hosted zone to add DNS records if `cnames` are provided | `string` | `null` | no |
Expand Down

0 comments on commit 356fa27

Please sign in to comment.