Class: Aws::S3::BucketVersioning
- Inherits:
-
Object
- Object
- Aws::S3::BucketVersioning
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/bucket_versioning.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#mfa_delete ⇒ String
Specifies whether MFA delete is enabled in the bucket versioning configuration.
-
#status ⇒ String
The versioning state of the bucket.
Actions collapse
- #enable(options = {}) ⇒ EmptyStructure
- #put(options = {}) ⇒ EmptyStructure
- #suspend(options = {}) ⇒ EmptyStructure
Associations collapse
- #bucket ⇒ Bucket
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetBucketVersioningOutput
Returns the data for this BucketVersioning.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ BucketVersioning
constructor
A new instance of BucketVersioning.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketVersioning.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketVersioning #initialize(options = {}) ⇒ BucketVersioning
Returns a new instance of BucketVersioning.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-s3/bucket_versioning.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
252 253 254 255 256 257 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 252 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 29 def bucket_name @bucket_name end |
#client ⇒ Client
51 52 53 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 51 def client @client end |
#data ⇒ Types::GetBucketVersioningOutput
Returns the data for this Aws::S3::BucketVersioning. Calls Client#get_bucket_versioning if #data_loaded? is ‘false`.
71 72 73 74 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 71 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
79 80 81 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 79 def data_loaded? !!@data end |
#enable(options = {}) ⇒ EmptyStructure
192 193 194 195 196 197 198 199 200 201 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 192 def enable( = {}) = Aws::Util.deep_merge(, bucket: @bucket_name, versioning_configuration: { status: "Enabled" } ) resp = @client.put_bucket_versioning() 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.
261 262 263 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 261 def identifiers { bucket_name: @bucket_name } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::BucketVersioning. Returns ‘self` making it possible to chain methods.
bucket_versioning.reload.data
61 62 63 64 65 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 61 def load resp = @client.get_bucket_versioning(bucket: @bucket_name) @data = resp.data self end |
#mfa_delete ⇒ String
Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
44 45 46 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 44 def mfa_delete data[:mfa_delete] end |
#put(options = {}) ⇒ EmptyStructure
220 221 222 223 224 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 220 def put( = {}) = .merge(bucket: @bucket_name) resp = @client.put_bucket_versioning() resp.data end |
#status ⇒ String
The versioning state of the bucket.
35 36 37 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 35 def status data[:status] end |
#suspend(options = {}) ⇒ EmptyStructure
238 239 240 241 242 243 244 245 246 247 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 238 def suspend( = {}) = Aws::Util.deep_merge(, bucket: @bucket_name, versioning_configuration: { status: "Suspended" } ) resp = @client.put_bucket_versioning() 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
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/aws-sdk-s3/bucket_versioning.rb', line 161 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 |