ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

providers/aws: Add docs for S3 website

This commit is contained in:
Justin Campbell 2015-05-01 09:48:08 -04:00
parent 348942d3fb
commit 564b7e1e67
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/source/docs/providers/aws/r/s3_bucket.html.markdown
View File

@ -12,6 +12,8 @@ Provides a S3 bucket resource.
## Example Usage ## Example Usage
### Private Bucket w/ Tags
``` ```
resource "aws_s3_bucket" "b" { resource "aws_s3_bucket" "b" {
bucket = "my_tf_test_bucket" bucket = "my_tf_test_bucket"
@ -24,6 +26,20 @@ resource "aws_s3_bucket" "b" {
} }
``` ```
### Static Website Hosting
```
resource "aws_s3_bucket" "b" {
bucket = "s3-website-test.hashicorp.com"
acl = "public-read"
website {
index_document = "index.html"
error_document = "error.html"
}
}
```
## Argument Reference ## Argument Reference
The following arguments are supported: The following arguments are supported:
@ -31,10 +47,16 @@ The following arguments are supported:
* `bucket` - (Required) The name of the bucket. * `bucket` - (Required) The name of the bucket.
* `acl` - (Optional) The [canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Defaults to "private". * `acl` - (Optional) The [canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Defaults to "private".
* `tags` - (Optional) A mapping of tags to assign to the bucket. * `tags` - (Optional) A mapping of tags to assign to the bucket.
* `website` - (Optional) A website object (documented below).
The website object supports the following:
* `index_document` - (Required) Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders.
* `error_document` - (Optional) An absolute path to the document to return in case of a 4XX error.
## Attributes Reference ## Attributes Reference
The following attributes are exported: The following attributes are exported:
* `id` - The name of the bucket * `id` - The name of the bucket.
* `website_endpoint` - The website endpoint, if the bucket is configured with a website. If not, this will be an empty string.