Skip to content

Commit b0960c0

Browse files
authored
Update README.yaml (#30)
* Update README.yaml * Update README.yaml
1 parent 0ac4ad3 commit b0960c0

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Terraform module to easily provision an AWS CloudFront CDN with an S3 or custom
1010

1111
---
1212

13-
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
13+
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
1414

1515

1616
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -97,6 +97,7 @@ Available targets:
9797
| cors_allowed_origins | List of allowed origins (e.g. example.com, test.com) for S3 bucket | list | `<list>` | no |
9898
| cors_expose_headers | List of expose header in the response for S3 bucket | list | `<list>` | no |
9999
| cors_max_age_seconds | Time in seconds that browser can cache the response for S3 bucket | string | `3600` | no |
100+
| custom_error_response | List of one or more custom error response element maps | list | `<list>` | no |
100101
| default_root_object | Object that CloudFront return when requests the root URL | string | `index.html` | no |
101102
| default_ttl | Default amount of time (in seconds) that an object is in a CloudFront cache | string | `60` | no |
102103
| delimiter | Delimiter to be used between `name`, `namespace`, `stage`, etc. | string | `-` | no |
@@ -120,7 +121,7 @@ Available targets:
120121
| null | an empty string | string | `` | no |
121122
| origin_bucket | Name of S3 bucket | string | `` | no |
122123
| origin_force_destroy | Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. `true` or `false`) | string | `false` | no |
123-
| origin_path | (Optional) - An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path. | string | `` | no |
124+
| origin_path | When set, will cause CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a `/`. Do not add a `/` at the end of the path. | string | `` | no |
124125
| parent_zone_id | ID of the hosted zone to contain this record (or specify `parent_zone_name`) | string | `` | no |
125126
| parent_zone_name | Name of the hosted zone to contain this record (or specify `parent_zone_id`) | string | `` | no |
126127
| price_class | Price class for this distribution: `PriceClass_All`, `PriceClass_200`, `PriceClass_100` | string | `PriceClass_100` | no |
@@ -163,9 +164,9 @@ File a GitHub [issue](https://github.com/cloudposse/terraform-aws-cloudfront-s3-
163164

164165
## Commercial Support
165166

166-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
167+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
167168

168-
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
169+
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
169170

170171
[![E-Mail](https://img.shields.io/badge/[email protected])](mailto:[email protected])
171172

@@ -175,7 +176,7 @@ We provide [*commercial support*][commercial_support] for all of our [Open Sourc
175176
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
176177
- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
177178
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
178-
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
179+
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
179180

180181

181182
## Community Forum
@@ -209,9 +210,9 @@ Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
209210

210211

211212

212-
## License
213+
## License
213214

214-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
215+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
215216

216217
See [LICENSE](LICENSE) for full details.
217218

@@ -252,7 +253,7 @@ This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? P
252253

253254
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
254255

255-
We offer paid support on all of our projects.
256+
We offer paid support on all of our projects.
256257

257258
Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
258259

docs/terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
| null | an empty string | string | `` | no |
4141
| origin_bucket | Name of S3 bucket | string | `` | no |
4242
| origin_force_destroy | Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. `true` or `false`) | string | `false` | no |
43-
| origin_path | (Optional) - An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path. | string | `` | no |
43+
| origin_path | When set, will cause CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a `/`. Do not add a `/` at the end of the path. | string | `` | no |
4444
| parent_zone_id | ID of the hosted zone to contain this record (or specify `parent_zone_name`) | string | `` | no |
4545
| parent_zone_name | Name of the hosted zone to contain this record (or specify `parent_zone_id`) | string | `` | no |
4646
| price_class | Price class for this distribution: `PriceClass_All`, `PriceClass_200`, `PriceClass_100` | string | `PriceClass_100` | no |

variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ variable "origin_bucket" {
6565

6666
variable "origin_path" {
6767
# http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath
68-
description = "(Optional) - An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path."
68+
description = "When set, will cause CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a `/`. Do not add a `/` at the end of the path."
6969
default = ""
7070
}
7171

@@ -252,7 +252,7 @@ DOC
252252
variable "custom_error_response" {
253253
# http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html#custom-error-pages-procedure
254254
# https://www.terraform.io/docs/providers/aws/r/cloudfront_distribution.html#custom-error-response-arguments
255-
description = "(Optional) - List of one or more custom error response element maps"
255+
description = "List of one or more custom error response element maps"
256256

257257
type = "list"
258258
default = []

0 commit comments

Comments
 (0)