Class: Aws::S3::Types::LoggingEnabled

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass LoggingEnabled data as a hash:

{
  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
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#target_bucket ⇒ String

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different ‘TargetPrefix` for each source bucket so that the delivered log files can be distinguished by key.

Returns:

  • (String) 


7397
7398
7399
7400
7401
7402
 
# File 'lib/aws-sdk-s3/types.rb', line 7397

class LoggingEnabled < Struct.new(
  :target_bucket,
  :target_grants,
  :target_prefix)
  include Aws::Structure
end

#target_grants ⇒ Array<Types::TargetGrant>

Container for granting information.

Returns:



7397
7398
7399
7400
7401
7402
 
# File 'lib/aws-sdk-s3/types.rb', line 7397

class LoggingEnabled < Struct.new(
  :target_bucket,
  :target_grants,
  :target_prefix)
  include Aws::Structure
end

#target_prefix ⇒ String

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

Returns:

  • (String) 


7397
7398
7399
7400
7401
7402
 
# File 'lib/aws-sdk-s3/types.rb', line 7397

class LoggingEnabled < Struct.new(
  :target_bucket,
  :target_grants,
  :target_prefix)
  include Aws::Structure
end