Skip to content

Commit

Permalink
providers/aws: Add docs for S3 website
Browse files Browse the repository at this point in the history
  • Loading branch information
justincampbell committed May 2, 2015
1 parent b3e16cb commit 1493cfb
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions website/source/docs/providers/aws/r/s3_bucket.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Provides a S3 bucket resource.

## Example Usage

### Private Bucket w/ Tags

```
resource "aws_s3_bucket" "b" {
bucket = "my_tf_test_bucket"
Expand All @@ -24,17 +26,37 @@ 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

The following arguments are supported:

* `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".
* `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

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.

0 comments on commit 1493cfb

Please sign in to comment.