You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Actions collapse

Associations collapse

Read-Only Attributes 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)


19
20
21
22
23
24
25
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 19

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:



278
279
280
281
282
283
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 278

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

#bucket_nameString

Returns:

  • (String)


30
31
32
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 30

def bucket_name
  @bucket_name
end

#clientClient

Returns:



52
53
54
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 52

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:



72
73
74
75
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 72

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.



80
81
82
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 80

def data_loaded?
  !!@data
end

#enable(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

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.

Returns:

  • (EmptyStructure)


201
202
203
204
205
206
207
208
209
210
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 201

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)


62
63
64
65
66
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 62

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)


45
46
47
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 45

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
  },
})

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.

Returns:

  • (EmptyStructure)


238
239
240
241
242
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 238

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)


36
37
38
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 36

def status
  data[:status]
end

#suspend(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

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.

Returns:

  • (EmptyStructure)


264
265
266
267
268
269
270
271
272
273
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 264

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 = {}, &block) ⇒ 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) {|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

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

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb', line 162

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