Class: Aws::S3::BucketLifecycleConfiguration
- Inherits:
-
Object
- Object
- Aws::S3::BucketLifecycleConfiguration
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#bucket_name ⇒ String
-
#rules ⇒ Array<Types::LifecycleRule>
Container for a lifecycle rule.
-
#transition_default_minimum_object_size ⇒ String
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
Actions collapse
-
#delete(options = {}) ⇒ EmptyStructure
-
#put(options = {}) ⇒ Types::PutBucketLifecycleConfigurationOutput
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::GetBucketLifecycleConfigurationOutput
Returns the data for this BucketLifecycleConfiguration.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ BucketLifecycleConfiguration
constructor
A new instance of BucketLifecycleConfiguration.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketLifecycleConfiguration.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketLifecycleConfiguration #initialize(options = {}) ⇒ BucketLifecycleConfiguration
Returns a new instance of BucketLifecycleConfiguration.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket ⇒ Bucket
332 333 334 335 336 337 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 332 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
33 34 35 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 33 def bucket_name @bucket_name end |
#client ⇒ Client
66 67 68 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 66 def client @client end |
#data ⇒ Types::GetBucketLifecycleConfigurationOutput
Returns the data for this Aws::S3::BucketLifecycleConfiguration. Calls
Client#get_bucket_lifecycle_configuration if #data_loaded? is false
.
88 89 90 91 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 88 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
96 97 98 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 96 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
212 213 214 215 216 217 218 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 212 def delete( = {}) = .merge(bucket: @bucket_name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_bucket_lifecycle() end resp.data end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::BucketLifecycleConfiguration.
Returns self
making it possible to chain methods.
bucket_lifecycle_configuration.reload.data
76 77 78 79 80 81 82 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 76 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_bucket_lifecycle_configuration(bucket: @bucket_name) end @data = resp.data self end |
#put(options = {}) ⇒ Types::PutBucketLifecycleConfigurationOutput
321 322 323 324 325 326 327 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 321 def put( = {}) = .merge(bucket: @bucket_name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.put_bucket_lifecycle_configuration() end resp.data end |
#rules ⇒ Array<Types::LifecycleRule>
Container for a lifecycle rule.
39 40 41 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 39 def rules data[:rules] end |
#transition_default_minimum_object_size ⇒ String
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
all_storage_classes_128K
- Objects smaller than 128 KB will not transition to any storage class by default.varies_by_storage_class
- Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a
filter that specifies a custom ObjectSizeGreaterThan
or
ObjectSizeLessThan
in the body of your transition rule. Custom
filters always take precedence over the default transition behavior.
59 60 61 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 59 def transition_default_minimum_object_size data[:transition_default_minimum_object_size] end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) 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
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 180 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |