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 S3 API Reference*.

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


9901
9902
9903
9904
9905
9906
9907
 
# File 'lib/aws-sdk-s3/types.rb', line 9901

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

#target_grants ⇒ Array<Types::TargetGrant>

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don’t support target grants. For more information, see

Permissions for server access log delivery][1

in the *Amazon S3

User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general

Returns:



9901
9902
9903
9904
9905
9906
9907
 
# File 'lib/aws-sdk-s3/types.rb', line 9901

class LoggingEnabled < Struct.new(
  :target_bucket,
  :target_grants,
  :target_prefix)
  SENSITIVE = []
  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) 


9901
9902
9903
9904
9905
9906
9907
 
# File 'lib/aws-sdk-s3/types.rb', line 9901

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