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

Class: Aws::S3::BucketLogging

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

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


19
20
21
22
23
24
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.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)
end

Instance Method Details

#bucketBucket

Returns:



111
112
113
114
115
116
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.rb', line 111

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

#bucket_nameString

Returns:

  • (String)


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

def bucket_name
  @bucket_name
end

#clientClient

Returns:



41
42
43
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.rb', line 41

def client
  @client
end

#dataTypes::GetBucketLoggingOutput

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

Returns:



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

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.



69
70
71
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.rb', line 69

def data_loaded?
  !!@data
end

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


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

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

#logging_enabledTypes::LoggingEnabled



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

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",
      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",
    },
  },
  content_md5: "ContentMD5",
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


102
103
104
105
106
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.rb', line 102

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