Module: AWS::S3::Logging::Management::ClassMethods

Defined in:
lib/aws/s3/logging.rb

Instance Method Summary collapse

Instance Method Details

#disable_logging_for(name = nil) ⇒ Object Also known as: disable_logging

Disables logging for the bucket named name.



109
110
111
 
# File 'lib/aws/s3/logging.rb', line 109

def disable_logging_for(name = nil)
  logging_status(bucket_name(name), Status.new)
end

#enable_logging_for(name = nil, options = {}) ⇒ Object Also known as: enable_logging

Enables logging for the bucket named name. You can specify what bucket to log to with the 'target_bucket' option as well as what prefix to add to the log files with the 'target_prefix' option. Unless you specify otherwise, logs will be delivered to the same bucket that is being logged and will be prefixed with log-.



99
100
101
102
103
104
105
 
# File 'lib/aws/s3/logging.rb', line 99

def enable_logging_for(name = nil, options = {})
  name            = bucket_name(name)
  default_options = {'target_bucket' => name, 'target_prefix' => 'log-'}
  options         = default_options.merge(options)
  grant_logging_access_to_target_bucket(options['target_bucket'])
  logging_status(name, Status.new(options))
end

#logging_enabled_for?(name = nil) ⇒ Boolean Also known as: logging_enabled?

Returns true if logging has been enabled for the bucket named name.

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/aws/s3/logging.rb', line 115

def logging_enabled_for?(name = nil)
  logging_status(bucket_name(name)).logging_enabled?
end

#logging_status_for(name = nil, status = nil) ⇒ Object Also known as: logging_status

Returns the logging status for the bucket named name. From the logging status you can determine the bucket logs are delivered to and what the bucket object’s keys are prefixed with. For more information see the Logging::Status class.

Bucket.logging_status_for 'marcel'



85
86
87
88
89
90
91
92
93
 
# File 'lib/aws/s3/logging.rb', line 85

def logging_status_for(name = nil, status = nil)
  if name.is_a?(Status)
    status = name
    name   = nil
  end

  path = path(name) << '?logging'
  status ? put(path, {}, status.to_xml) : Status.new(get(path).parsed)
end

#logs_for(name = nil) ⇒ Object Also known as: logs

Returns the collection of logs for the bucket named name.

Bucket.logs_for 'marcel'



123
124
125
126
127
128
 
# File 'lib/aws/s3/logging.rb', line 123

def logs_for(name = nil)
  name = bucket_name(name)
  logging_status = logging_status_for(name)
  return [] unless logging_status.logging_enabled?
  objects(logging_status.target_bucket, :prefix => logging_status.target_prefix)
end