Class: Aws::S3::BucketWebsite

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, options = {}) ⇒ BucketWebsite #initialize(options = {}) ⇒ BucketWebsite

Returns a new instance of BucketWebsite.

Overloads:

  • #initialize(bucket_name, options = {}) ⇒ BucketWebsite

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketWebsite

    Options Hash (options):

    • :bucket_name (required, String)
    • :client (Client)


22
23
24
25
26
27
28
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#bucketBucket

Returns:



263
264
265
266
267
268
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 263

def bucket
  Bucket.new(
    name: @bucket_name,
    client: @client
  )
end

#bucket_nameString

Returns:

  • (String)


33
34
35
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 33

def bucket_name
  @bucket_name
end

#clientClient

Returns:



68
69
70
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 68

def client
  @client
end

#dataTypes::GetBucketWebsiteOutput

Returns the data for this Aws::S3::BucketWebsite. Calls Client#get_bucket_website if #data_loaded? is false.

Returns:



88
89
90
91
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 88

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



96
97
98
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 96

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_website.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


204
205
206
207
208
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 204

def delete(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.delete_bucket_website(options)
  resp.data
end

#error_documentTypes::ErrorDocument

The object key name of the website error document to use for 4XX class errors.



54
55
56
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 54

def error_document
  data[:error_document]
end

#index_documentTypes::IndexDocument

The name of the index document for the website (for example index.html).



47
48
49
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 47

def index_document
  data[:index_document]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::S3::BucketWebsite. Returns self making it possible to chain methods.

bucket_website.reload.data

Returns:

  • (self)


78
79
80
81
82
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 78

def load
  resp = @client.get_bucket_website(bucket: @bucket_name)
  @data = resp.data
  self
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_website.put({
  content_md5: "ContentMD5",
  website_configuration: { # required
    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",
        },
      },
    ],
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :content_md5 (String)

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

  • :website_configuration (required, Types::WebsiteConfiguration)

    Container for the request.

Returns:

  • (EmptyStructure)


254
255
256
257
258
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 254

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_website(options)
  resp.data
end

#redirect_all_requests_toTypes::RedirectAllRequestsTo

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.



40
41
42
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 40

def redirect_all_requests_to
  data[:redirect_all_requests_to]
end

#routing_rulesArray<Types::RoutingRule>

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

Returns:



61
62
63
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 61

def routing_rules
  data[:routing_rules]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb', line 180

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end