Class: Aws::S3::Types::WebsiteConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass WebsiteConfiguration data as a hash:

{
  error_document: {
    key: "ObjectKey", # required
  },
  index_document: {
    suffix: "Suffix", # required
  },
  redirect_all_requests_to: {
    host_name: "HostName", # required
    protocol: "http", # accepts http, https
  },
  routing_rules: [
    {
      condition: {
        http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
        key_prefix_equals: "KeyPrefixEquals",
      },
      redirect: { # required
        host_name: "HostName",
        http_redirect_code: "HttpRedirectCode",
        protocol: "http", # accepts http, https
        replace_key_prefix_with: "ReplaceKeyPrefixWith",
        replace_key_with: "ReplaceKeyWith",
      },
    },
  ],
}

Specifies website configuration parameters for an Amazon S3 bucket.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_documentTypes::ErrorDocument

The name of the error document for the website.



17219
17220
17221
17222
17223
17224
17225
17226
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17219

class WebsiteConfiguration < Struct.new(
  :error_document,
  :index_document,
  :redirect_all_requests_to,
  :routing_rules)
  SENSITIVE = []
  include Aws::Structure
end

#index_documentTypes::IndexDocument

The name of the index document for the website.



17219
17220
17221
17222
17223
17224
17225
17226
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17219

class WebsiteConfiguration < Struct.new(
  :error_document,
  :index_document,
  :redirect_all_requests_to,
  :routing_rules)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_all_requests_toTypes::RedirectAllRequestsTo

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

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



17219
17220
17221
17222
17223
17224
17225
17226
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17219

class WebsiteConfiguration < Struct.new(
  :error_document,
  :index_document,
  :redirect_all_requests_to,
  :routing_rules)
  SENSITIVE = []
  include Aws::Structure
end

#routing_rulesArray<Types::RoutingRule>

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

Returns:



17219
17220
17221
17222
17223
17224
17225
17226
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17219

class WebsiteConfiguration < Struct.new(
  :error_document,
  :index_document,
  :redirect_all_requests_to,
  :routing_rules)
  SENSITIVE = []
  include Aws::Structure
end