AWS Documentation » AWS CloudFormation » User Guide » Amazon Simple Storage Service Resource Type Reference » AWS::S3::Bucket » AWS::S3::Bucket WebsiteConfiguration

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Filter View: All JSON YAML

AWS::S3::Bucket WebsiteConfiguration

Specifies website configuration parameters for an Amazon S3 bucket.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ErrorDocument" : String,
  "IndexDocument" : String,
  "RedirectAllRequestsTo" : RedirectAllRequestsTo,
  "RoutingRules" : [ RoutingRule, ... ]
}

YAML

  ErrorDocument: String
  IndexDocument: String
  RedirectAllRequestsTo: 
    RedirectAllRequestsTo
  RoutingRules: 
    - RoutingRule

Properties

ErrorDocument

The name of the error document for the website.

Required: No

Type: String

Update requires: No interruption

IndexDocument

The name of the index document for the website.

Required: No

Type: String

Update requires: No interruption

RedirectAllRequestsTo

The redirect behavior for every request to this bucket's website endpoint.

Important

If you specify this property, you can't specify any other property.

Required: No

Type: RedirectAllRequestsTo

Update requires: No interruption

RoutingRules

Rules that define when a redirect is applied and the redirect behavior.

Required: No

Type: List of RoutingRule

Update requires: No interruption