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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LoggingEnabled as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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) —

    Specifies the bucket where you want Amazon S3 to store server access logs.

#target_grants ⇒ Array<Types::TargetGrant>

Container for granting information.

Returns:

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

    A prefix for all log object keys.