Class: Aws::S3::BucketLogging

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketLogging.

Overloads:

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

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketLogging

    Options Hash (options):

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


20
21
22
23
24
25
26
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 20

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:



220
221
222
223
224
225
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 220

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

#bucket_name ⇒ String

Returns:

  • (String) 


31
32
33
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 31

def bucket_name
  @bucket_name
end

#client ⇒ Client

Returns:



51
52
53
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 51

def client
  @client
end

#data ⇒ Types::GetBucketLoggingOutput

Returns the data for this Aws::S3::BucketLogging. Calls Client#get_bucket_logging if #data_loaded? is ‘false`.

Returns:



71
72
73
74
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 71

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.



79
80
81
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 79

def data_loaded?
  !!@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. 


229
230
231
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 229

def identifiers
  { bucket_name: @bucket_name }
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::S3::BucketLogging. Returns ‘self` making it possible to chain methods.

bucket_logging.reload.data

Returns:

  • (self) 


61
62
63
64
65
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 61

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

#logging_enabled ⇒ Types::LoggingEnabled

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see [PUT Bucket logging] in the *Amazon Simple Storage Service API Reference*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html

Returns:



44
45
46
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 44

def logging_enabled
  data[:logging_enabled]
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_logging.put({
  bucket_logging_status: { # required
    logging_enabled: {
      target_bucket: "TargetBucket", # required
      target_grants: [
        {
          grantee: {
            display_name: "DisplayName",
            email_address: "EmailAddress",
            id: "ID",
            type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
            uri: "URI",
          },
          permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE
        },
      ],
      target_prefix: "TargetPrefix", # required
    },
  },
  content_md5: "ContentMD5",
})

Parameters:

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

    ({})

Options Hash (options):

  • :bucket_logging_status (required, Types::BucketLoggingStatus) —

    Container for logging status information.

  • :content_md5 (String) —

    The MD5 hash of the ‘PutBucketLogging` request body.

Returns:

  • (EmptyStructure) 


211
212
213
214
215
 
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 211

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_logging(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



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

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