Class: AWS::S3::BucketLifecycleConfiguration::Rule

Inherits:
Object
  • Object
show all
Defined in:
lib/aws/s3/bucket_lifecycle_configuration.rb

Overview

Represents a single rule from an Amazon S3 bucket lifecycle configuration.

# delete all objects with the prefix 'temporary/' after 10 days
bucket.lifecycle_configuration.add_rule 'temporary/', 10

# remove the rule created above
bucket.lifecycle_configuration.remove_rule 'temporary/'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration, id, prefix, expiration_days, status) ⇒ Rule

Returns a new instance of Rule.



306
307
308
309
310
311
312
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 306

def initialize configuration, id, prefix, expiration_days, status
  @configuration = configuration
  @id = id
  @prefix = prefix
  @expiration_days = expiration_days
  @status = status
end

Instance Attribute Details

#configuration ⇒ BucketLifecycleConfiguration (readonly)

Returns:



315
316
317
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 315

def configuration
  @configuration
end

#expiration_days ⇒ Integer

Returns:

  • (Integer) 


324
325
326
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 324

def expiration_days
  @expiration_days
end

#id ⇒ String (readonly)

Returns:

  • (String) 


318
319
320
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 318

def id
  @id
end

#prefix ⇒ String

Returns:

  • (String) 


321
322
323
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 321

def prefix
  @prefix
end

#status ⇒ String

Returns the rule status, ‘Enabled’ or ‘Disabled’

Returns:

  • (String) —

    Returns the rule status, ‘Enabled’ or ‘Disabled’



327
328
329
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 327

def status
  @status
end

Instance Method Details

#disabled! ⇒ Object 



341
342
343
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 341

def disabled!
  self.status = 'Disabled'
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


337
338
339
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 337

def disabled?
  status == 'Disabled'
end

#enable! ⇒ Object 



333
334
335
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 333

def enable!
  self.status = 'Enabled'
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


329
330
331
 
# File 'lib/aws/s3/bucket_lifecycle_configuration.rb', line 329

def enabled?
  status == 'Enabled'
end