Class: Aws::S3::BucketLifecycleConfiguration

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-s3/bucket_lifecycle_configuration.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, options = {}) ⇒ BucketLifecycleConfiguration #initialize(options = {}) ⇒ BucketLifecycleConfiguration

Returns a new instance of BucketLifecycleConfiguration.

Overloads:



22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#bucket ⇒ Bucket

Returns:



332
333
334
335
336
337
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 332

def bucket
  Bucket.new(
    name: @bucket_name,
    client: @client
  )
end

#bucket_name ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 33

def bucket_name
  @bucket_name
end

#client ⇒ Client

Returns:



66
67
68
 
# File '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`.

Returns:



88
89
90
91
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 88

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



96
97
98
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 96

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_lifecycle_configuration.delete({
  expected_bucket_owner: "AccountId",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (EmptyStructure) 


212
213
214
215
216
217
218
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 212

def delete(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_bucket_lifecycle(options)
  end
  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.

Deprecated. 


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

def identifiers
  { bucket_name: @bucket_name }
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

Returns:

  • (self) 


76
77
78
79
80
81
82
 
# File '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

Examples:

Request syntax with placeholder values


bucket_lifecycle_configuration.put({
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  lifecycle_configuration: {
    rules: [ # required
      {
        expiration: {
          date: Time.now,
          days: 1,
          expired_object_delete_marker: false,
        },
        id: "ID",
        prefix: "Prefix",
        filter: {
          prefix: "Prefix",
          tag: {
            key: "ObjectKey", # required
            value: "Value", # required
          },
          object_size_greater_than: 1,
          object_size_less_than: 1,
          and: {
            prefix: "Prefix",
            tags: [
              {
                key: "ObjectKey", # required
                value: "Value", # required
              },
            ],
            object_size_greater_than: 1,
            object_size_less_than: 1,
          },
        },
        status: "Enabled", # required, accepts Enabled, Disabled
        transitions: [
          {
            date: Time.now,
            days: 1,
            storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
          },
        ],
        noncurrent_version_transitions: [
          {
            noncurrent_days: 1,
            storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
            newer_noncurrent_versions: 1,
          },
        ],
        noncurrent_version_expiration: {
          noncurrent_days: 1,
          newer_noncurrent_versions: 1,
        },
        abort_incomplete_multipart_upload: {
          days_after_initiation: 1,
        },
      },
    ],
  },
  expected_bucket_owner: "AccountId",
  transition_default_minimum_object_size: "varies_by_storage_class", # accepts varies_by_storage_class, all_storage_classes_128K
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :checksum_algorithm (String) —

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send this header, there must be a corresponding ‘x-amz-checksum` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    If you provide an individual checksum, Amazon S3 ignores any provided ‘ChecksumAlgorithm` parameter.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :lifecycle_configuration (Types::BucketLifecycleConfiguration) —

    Container for lifecycle rules. You can add as many as 1,000 rules.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :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.

Returns:



321
322
323
324
325
326
327
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 321

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_bucket_lifecycle_configuration(options)
  end
  resp.data
end

#rules ⇒ Array<Types::LifecycleRule>

Container for a lifecycle rule.

Returns:



39
40
41
 
# File '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.

Returns:

  • (String) 


59
60
61
 
# File '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

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-s3/bucket_lifecycle_configuration.rb', line 180

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end