Class: Aws::S3::BucketVersioning

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketVersioning.

Overloads:

  • #initialize(bucket_name, options = {}) ⇒ BucketVersioning

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketVersioning

    Options Hash (options):

    • :bucket_name (required, String)
    • :client (Client)


22
23
24
25
26
27
28
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.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

#bucketBucket

Returns:



298
299
300
301
302
303
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 298

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

#bucket_nameString

Returns:

  • (String)


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

def bucket_name
  @bucket_name
end

#clientClient

Returns:



55
56
57
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 55

def client
  @client
end

#dataTypes::GetBucketVersioningOutput

Returns the data for this Aws::S3::BucketVersioning. Calls Client#get_bucket_versioning if #data_loaded? is false.

Returns:



75
76
77
78
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 75

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.



83
84
85
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 83

def data_loaded?
  !!@data
end

#enable(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_versioning.enable({
  content_md5: "ContentMD5",
  mfa: "MFA",
  expected_bucket_owner: "AccountId",
})

Parameters:

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

    ({})

Options Hash (options):

  • :content_md5 (String)

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

  • :mfa (String)

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

  • :expected_bucket_owner (String)

    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (EmptyStructure)


211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 211

def enable(options = {})
  options = Aws::Util.deep_merge(options,
    bucket: @bucket_name,
    versioning_configuration: {
      status: "Enabled"
    }
  )
  resp = @client.put_bucket_versioning(options)
  resp.data
end

#loadself 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

Returns:

  • (self)


65
66
67
68
69
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 65

def load
  resp = @client.get_bucket_versioning(bucket: @bucket_name)
  @data = resp.data
  self
end

#mfa_deleteString

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.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 48

def mfa_delete
  data[:mfa_delete]
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_versioning.put({
  content_md5: "ContentMD5",
  mfa: "MFA",
  versioning_configuration: { # required
    mfa_delete: "Enabled", # accepts Enabled, Disabled
    status: "Enabled", # accepts Enabled, Suspended
  },
  expected_bucket_owner: "AccountId",
})

Parameters:

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

    ({})

Options Hash (options):

  • :content_md5 (String)

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

  • :mfa (String)

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

  • :versioning_configuration (required, Types::VersioningConfiguration)

    Container for setting the versioning state.

  • :expected_bucket_owner (String)

    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (EmptyStructure)


253
254
255
256
257
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 253

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_versioning(options)
  resp.data
end

#statusString

The versioning state of the bucket.

Returns:

  • (String)


39
40
41
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 39

def status
  data[:status]
end

#suspend(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_versioning.suspend({
  content_md5: "ContentMD5",
  mfa: "MFA",
  expected_bucket_owner: "AccountId",
})

Parameters:

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

    ({})

Options Hash (options):

  • :content_md5 (String)

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

  • :mfa (String)

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

  • :expected_bucket_owner (String)

    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (EmptyStructure)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 284

def suspend(options = {})
  options = Aws::Util.deep_merge(options,
    bucket: @bucket_name,
    versioning_configuration: {
      status: "Suspended"
    }
  )
  resp = @client.put_bucket_versioning(options)
  resp.data
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 167

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::Waiters::Waiter.new(options).wait({})
end