Class: Aws::S3::BucketWebsite
- Inherits:
-
Object
- Object
- Aws::S3::BucketWebsite
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/bucket_website.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
- #error_document ⇒ Types::ErrorDocument
- #index_document ⇒ Types::IndexDocument
- #redirect_all_requests_to ⇒ Types::RedirectAllRequestsTo
- #routing_rules ⇒ Array<Types::RoutingRule>
Actions collapse
Associations collapse
- #bucket ⇒ Bucket
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetBucketWebsiteOutput
Returns the data for this BucketWebsite.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ BucketWebsite
constructor
A new instance of BucketWebsite.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketWebsite.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketWebsite #initialize(options = {}) ⇒ BucketWebsite
Returns a new instance of BucketWebsite.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#bucket ⇒ Bucket
241 242 243 244 245 246 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 241 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 29 def bucket_name @bucket_name end |
#data ⇒ Types::GetBucketWebsiteOutput
Returns the data for this Aws::S3::BucketWebsite. Calls Client#get_bucket_website if #data_loaded? is ‘false`.
76 77 78 79 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 76 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
84 85 86 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 84 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
190 191 192 193 194 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 190 def delete( = {}) = .merge(bucket: @bucket_name) resp = @client.delete_bucket_website() resp.data end |
#error_document ⇒ Types::ErrorDocument
44 45 46 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 44 def error_document data[:error_document] end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
250 251 252 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 250 def identifiers { bucket_name: @bucket_name } end |
#index_document ⇒ Types::IndexDocument
39 40 41 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 39 def index_document data[:index_document] end |
#load ⇒ self 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
66 67 68 69 70 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 66 def load resp = @client.get_bucket_website(bucket: @bucket_name) @data = resp.data self end |
#put(options = {}) ⇒ EmptyStructure
232 233 234 235 236 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 232 def put( = {}) = .merge(bucket: @bucket_name) resp = @client.put_bucket_website() resp.data end |
#redirect_all_requests_to ⇒ Types::RedirectAllRequestsTo
34 35 36 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 34 def redirect_all_requests_to data[:redirect_all_requests_to] end |
#routing_rules ⇒ Array<Types::RoutingRule>
49 50 51 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 49 def routing_rules data[:routing_rules] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::S3::Client] #wait_until instead
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() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
## 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
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/aws-sdk-s3/bucket_website.rb', line 166 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |