description = "Set to true if your S3 bucket is configured as a website and publicly accessible. Set to false if it's a regular S3 bucket and only privately accessible to CloudFront. If it's a public website, you can use all the S3 website features (e.g. routing, error pages), but users can bypass CloudFront and talk to S3 directly. If it's a private S3 bucket, users can only reach it via CloudFront, but you don't get all the website features."
type = string
}
variable "index_document" {
description = "The path that you want CloudFront to query on the origin server when an end user requests the root URL (e.g. index.html)."
type = string
}
variable "default_ttl" {
description = "The default amount of time, in seconds, that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an 'Cache-Control max-age' or 'Expires' header."
type = number
}
Questions? Ask away.
We're here to talk about our services, answer any questions, give advice, or just to chat.
{"treedata":{"name":"root","toggled":true,"children":[{"name":".circleci","children":[{"name":"config.yml","path":".circleci/config.yml","sha":"a13b7823aa66e7dc9796b1a0968c6842812b688b"}]},{"name":".gitignore","path":".gitignore","sha":"42cd2961e573dc1870292a576ddbb7d4d07cca6a"},{"name":"CODEOWNERS","path":"CODEOWNERS","sha":"7a0d0af6ee8361466674f9367fab91f9037b5c75"},{"name":"LICENSE.txt","path":"LICENSE.txt","sha":"f4e3d9bd4717a044ed31ad847a300eee74371a78"},{"name":"README.md","path":"README.md","sha":"a940fce1a435db01e0a90343bc30fbc1664d573a"},{"name":"examples","children":[{"name":"bin","children":[{"name":"s3-upload.sh","path":"examples/bin/s3-upload.sh","sha":"616167707b12a9ed678286f6829d06ae39b8bfb0"}]},{"name":"cloudfront-s3-private-origin-group","children":[{"name":"README.md","path":"examples/cloudfront-s3-private-origin-group/README.md","sha":"a0c7c49eb8bb405624377174bf28c48e806baf44"},{"name":"main.tf","path":"examples/cloudfront-s3-private-origin-group/main.tf","sha":"66ed5e32595587b69624bdc5b8f4b6cb39778f9b"},{"name":"outputs.tf","path":"examples/cloudfront-s3-private-origin-group/outputs.tf","sha":"7ad8a7de25248890dd41ec74575fb18e206cf93b"},{"name":"vars.tf","path":"examples/cloudfront-s3-private-origin-group/vars.tf","sha":"58848af7c7064fe5054c4612f3f48911db5182eb"}]},{"name":"cloudfront-s3-private","children":[{"name":"README.md","path":"examples/cloudfront-s3-private/README.md","sha":"03ae92790de376455152698d267caf86d2348911"},{"name":"main.tf","path":"examples/cloudfront-s3-private/main.tf","sha":"9e948f2cbb82473fce9c8ca51557098195840e9e"},{"name":"outputs.tf","path":"examples/cloudfront-s3-private/outputs.tf","sha":"4028b7c112eb547208079b450305f8560d451deb"},{"name":"vars.tf","path":"examples/cloudfront-s3-private/vars.tf","sha":"6c831e531701b3ae5745aa968008d28e1c6bc7a1"}]},{"name":"cloudfront-s3-public-origin-group","children":[{"name":"README.md","path":"examples/cloudfront-s3-public-origin-group/README.md","sha":"80e5a99578d8c9eba230531ac040a8e82aebfebd"},{"name":"main.tf","path":"examples/cloudfront-s3-public-origin-group/main.tf","sha":"dbddcbf9bd09eaafd7688dea6e64f270c892b3ac"},{"name":"outputs.tf","path":"examples/cloudfront-s3-public-origin-group/outputs.tf","sha":"7ad8a7de25248890dd41ec74575fb18e206cf93b"},{"name":"vars.tf","path":"examples/cloudfront-s3-public-origin-group/vars.tf","sha":"627d6c64c757b21e2b4ac175dfa72a9cf4df36b9"}]},{"name":"cloudfront-s3-public","children":[{"name":"README.md","path":"examples/cloudfront-s3-public/README.md","sha":"aed32ebaa3e145939ee0e027125583200673c104"},{"name":"main.tf","path":"examples/cloudfront-s3-public/main.tf","sha":"dd356b7e0c0397d35416cc4065533e5da3bcd969"},{"name":"outputs.tf","path":"examples/cloudfront-s3-public/outputs.tf","sha":"4028b7c112eb547208079b450305f8560d451deb"},{"name":"vars.tf","path":"examples/cloudfront-s3-public/vars.tf","sha":"48d19258f4605b2c687d13336f6ac77358d45c54"}]},{"name":"example-website","children":[{"name":"README.md","path":"examples/example-website/README.md","sha":"359ae6d06f8e77244f18c42704637b8e6ef498c6"},{"name":"error.html","path":"examples/example-website/error.html","sha":"b2b8878e00a2f707b709ae699ce466c543eab954"},{"name":"grunty.png","path":"examples/example-website/grunty.png","sha":"fa4bab8d46d843cd22b20f16bcda72e9d4c86680"},{"name":"index.html","path":"examples/example-website/index.html","sha":"a7a486627108114d5ca4a21f856e3b410c6b73e2"}]},{"name":"s3-static-website","children":[{"name":"README.md","path":"examples/s3-static-website/README.md","sha":"a2d9c34b338551214ccf7df40d63bfa98ae5bae6"},{"name":"main.tf","path":"examples/s3-static-website/main.tf","sha":"307eb8cc97c3d9fa63e5dbf7d22f5b351d433d63"},{"name":"outputs.tf","path":"examples/s3-static-website/outputs.tf","sha":"7c6be384ebcdb5c66d9432617ae165919160e006"},{"name":"vars.tf","path":"examples/s3-static-website/vars.tf","sha":"40c9704d894d599b88901b615c8adb38b9cdbc82"}]}]},{"name":"modules","children":[{"name":"_docs","children":[{"name":"s3-architecture.png","path":"modules/_docs/s3-architecture.png","sha":"24664de39064d5c6767105b75d002bddf763ff82"},{"name":"s3.png","path":"modules/_docs/s3.png","sha":"667a181c90817858914551e9b2fa376fa1c8f177"}]},{"name":"s3-cloudfront","children":[{"name":"README.md","path":"modules/s3-cloudfront/README.md","sha":"5b69068481d80e58832ea79b945458ce392e6ad7"},{"name":"main.tf","path":"modules/s3-cloudfront/main.tf","sha":"f1430d8243beaabb6c3c576fe240883b5d3db144"},{"name":"outputs.tf","path":"modules/s3-cloudfront/outputs.tf","sha":"fb0e7380080e2b16420ac47f255841ce468686cb"},{"name":"vars.tf","path":"modules/s3-cloudfront/vars.tf","sha":"e34608a384e4581500318e6aaa6480088e821f7e","toggled":true}],"toggled":true},{"name":"s3-static-website","children":[{"name":"README.adoc","path":"modules/s3-static-website/README.adoc","sha":"d880fe9a6293c0780999f39b43e99ce1a902c06d"},{"name":"core-concepts.md","path":"modules/s3-static-website/core-concepts.md","sha":"1cb65fe1aeb7081449431c56a8fc7dc5ba05007b"},{"name":"main.tf","path":"modules/s3-static-website/main.tf","sha":"75643050df6685db2bb17ebd0652fcd4f494b8ac"},{"name":"outputs.tf","path":"modules/s3-static-website/outputs.tf","sha":"9af4b14aee55ded582d970656949f3f7ae5647af"},{"name":"vars.tf","path":"modules/s3-static-website/vars.tf","sha":"622bc015edc9cde0df10229be5f3188689094486"}]}],"toggled":true},{"name":"test","children":[{"name":"Gopkg.lock","path":"test/Gopkg.lock","sha":"03773d142d1feac30669f3c13032d289d9e3a398"},{"name":"Gopkg.toml","path":"test/Gopkg.toml","sha":"a84c6ed7e5bfce6f72e9e08666f1665af01a3f84"},{"name":"README.md","path":"test/README.md","sha":"677e87a94c28a43bc370cf3641fa5390a3cd3b63"},{"name":"s3_cloudfront_canonical_user_test.go","path":"test/s3_cloudfront_canonical_user_test.go","sha":"cdddc74e688c82fffea183946fe0ed3d66581de8"},{"name":"s3_cloudfront_origin_group_test.go","path":"test/s3_cloudfront_origin_group_test.go","sha":"46aa9d45071a6d563596e131df875d34df054532"},{"name":"s3_cloudfront_perpetual_diff_test.go","path":"test/s3_cloudfront_perpetual_diff_test.go","sha":"7f08a006ec3dd839af4e0f7456de3648052abf06"},{"name":"s3_cloudfront_test.go","path":"test/s3_cloudfront_test.go","sha":"bd6afba183d1d17670746c3040a2d87f9e6246ee"},{"name":"s3_static_website_test.go","path":"test/s3_static_website_test.go","sha":"57110da7d6ecc3e3b941c59128c84b3c25524cf3"},{"name":"test_helpers.go","path":"test/test_helpers.go","sha":"13abdb0c2881ad74383328a6b7966a6c0a7fb7ce"}]}]},"detailsContent":"<div class=\"preview__body--content\"><div><ul class=\"code__list\"><li class=\"code__item\"><span class=\"code__text\"><span class=\"hljs-comment\"># ---------------------------------------------------------------------------------------------------------------------</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"><span class=\"hljs-comment\"># REQUIRED MODULE PARAMETERS</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"><span class=\"hljs-comment\"># These variables must be passed in by the operator.</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"><span class=\"hljs-comment\"># ---------------------------------------------------------------------------------------------------------------------</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"></span></li>\n<li class=\"code__item\"><span class=\"code__text\">variable <span class=\"hljs-string\">\"bucket_name\"</span> {</span></li>\n<li class=\"code__item\"><span class=\"code__text\"> description = <span class=\"hljs-string\">\"The name of the S3 bucket.\"</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"> <span class=\"hljs-built_in\">type</span> = string</span></li>\n<li class=\"code__item\"><span class=\"code__text\">}</span></li>\n<li class=\"code__item\"><span class=\"code__text\"></span></li>\n<li class=\"code__item\"><span class=\"code__text\">variable <span class=\"hljs-string\">\"s3_bucket_is_public_website\"</span> {</span></li>\n<li class=\"code__item\"><span class=\"code__text\"> description = <span class=\"hljs-string\">\"Set to true if your S3 bucket is configured as a website and publicly accessible. Set to false if it's a regular S3 bucket and only privately accessible to CloudFront. If it's a public website, you can use all the S3 website features (e.g. routing, error pages), but users can bypass CloudFront and talk to S3 directly. If it's a private S3 bucket, users can only reach it via CloudFront, but you don't get all the website features.\"</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"> <span class=\"hljs-built_in\">type</span> = string</span></li>\n<li class=\"code__item\"><span class=\"code__text\">}</span></li>\n<li class=\"code__item\"><span class=\"code__text\"></span></li>\n<li class=\"code__item\"><span class=\"code__text\">variable <span class=\"hljs-string\">\"index_document\"</span> {</span></li>\n<li class=\"code__item\"><span class=\"code__text\"> description = <span class=\"hljs-string\">\"The path that you want CloudFront to query on the origin server when an end user requests the root URL (e.g. index.html).\"</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"> <span class=\"hljs-built_in\">type</span> = string</span></li>\n<li class=\"code__item\"><span class=\"code__text\">}</span></li>\n<li class=\"code__item\"><span class=\"code__text\"></span></li>\n<li class=\"code__item\"><span class=\"code__text\">variable <span class=\"hljs-string\">\"default_ttl\"</span> {</span></li>\n<li class=\"code__item\"><span class=\"code__text\"> description = <span class=\"hljs-string\">\"The default amount of time, in seconds, that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an 'Cache-Control max-age' or 'Expires' header.\"</span></span></li>\n<li class=\"code__item\"><span class=\"code__text\"> <span class=\"hljs-built_in\">type</span> = number</span></li>\n<li class=\"code__item\"><span class=\"code__text\">}</span></li>\n<li class=\"code__item\"><span class=\"code__text\"></span></li></ul></div></div>","repoName":"package-static-assets","repoRef":"v0.6.5","serviceDescriptor":{"serviceName":"CloudFront","serviceRepoName":"package-static-assets","serviceRepoOrg":"gruntwork-io","serviceMainReadmePath":"/modules/s3-cloudfront","cloudProviders":["aws"],"description":"Deploy CloudFront as a CDN in front of your S3 bucket. Supports cache settings, Route 53 DNS entries, and TLS certs.","imageUrl":"cloudfront.png","licenseType":"subscriber","technologies":["Terraform"],"compliance":[],"tags":[""]},"serviceCategoryName":"Static content","fileName":"vars.tf","filePath":"/modules/s3-cloudfront/vars.tf","title":"Repo Browser: CloudFront","description":"Browse the repos in the Gruntwork Infrastructure as Code Library."}
.circleci
README.md
