Class: Aws::S3::BucketCors
- Inherits:
-
Object
- Object
- Aws::S3::BucketCors
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/bucket_cors.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
Actions collapse
Associations collapse
- #bucket ⇒ Bucket
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetBucketCorsOutput
Returns the data for this BucketCors.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ BucketCors
constructor
A new instance of BucketCors.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketCors.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketCors #initialize(options = {}) ⇒ BucketCors
Returns a new instance of BucketCors.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-s3/bucket_cors.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
210 211 212 213 214 215 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 210 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 29 def bucket_name @bucket_name end |
#cors_rules ⇒ Array<Types::CORSRule>
34 35 36 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 34 def cors_rules data[:cors_rules] end |
#data ⇒ Types::GetBucketCorsOutput
Returns the data for this Aws::S3::BucketCors. Calls Client#get_bucket_cors if #data_loaded? is ‘false`.
61 62 63 64 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 61 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
69 70 71 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 69 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
175 176 177 178 179 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 175 def delete( = {}) = .merge(bucket: @bucket_name) resp = @client.delete_bucket_cors() resp.data 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.
219 220 221 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 219 def identifiers { bucket_name: @bucket_name } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::BucketCors. Returns ‘self` making it possible to chain methods.
bucket_cors.reload.data
51 52 53 54 55 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 51 def load resp = @client.get_bucket_cors(bucket: @bucket_name) @data = resp.data self end |
#put(options = {}) ⇒ EmptyStructure
201 202 203 204 205 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 201 def put( = {}) = .merge(bucket: @bucket_name) resp = @client.put_bucket_cors() resp.data 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
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/aws-sdk-s3/bucket_cors.rb', line 151 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 |