Class AWS::S3::WebsiteConfiguration
In: lib/aws/s3/website_configuration.rb
Parent: Object

Methods

External Aliases

options -> to_hash

Attributes

options  [R]  @return [Hash]

Public Class methods

@option options [Hash] :redirect_all_requests_to

  Describes the redirect behavior for every request to this
  bucket's website endpoint. If this element is present, no
  other options are are allowed.
  * `:host_name` - (*required*, String)
    Name of the host where requests will be redirected.
  * `:protocol` - (String)
    Protocol to use (http, https) when redirecting requests. The
    default is the protocol that is used in the original request.

@option options [Hash] :index_document

  * `:suffix` - (*required*, String) - A suffix that is appended to
    a request that is for a directory on the website endpoint
    (e.g. if the suffix is index.html and you make a request to
    samplebucket/images/ the data that is returned will be for
    the object with the key name images/index.html).
    The suffix must not be empty and must not include a
    slash character.

@option options [Hash] :error_document

  * `:key` - (*required*, String) - The object key name to use
    when a 4XX class error occurs.

@option options [Array<Hash>] :routing_rules

  * `:redirect` - (*required*, Hash)
    * `:host_name` - (String)
    * `:protocol` - (String)
    * `:replace_key_prefix_with` - (String)
    * `:replace_key_with` - (String)
    * `:http_redirect_code` - (String)
  * `:condition` - (Hash)
    * `:key_prefix_equals` - (String)
    * `:http_error_code_returned_equals` - (String)

Public Instance methods

This method exists for backwards compatability. @return [String,nil] @api private

This method exists for backwards compatability. @api private

This method exists for backwards compatability. @return [String,nil] @api private

This method exists for backwards compatability. @api private

[Validate]