Class: Aws::S3::BucketLogging

Inherits:

Resources::Resource

• Object
• Resources::Resource
• Aws::S3::BucketLogging

Defined in:

(unknown)

Instance Attribute Summary

• #bucket_name ⇒ String readonly
• #logging_enabled ⇒ Types::LoggingEnabled readonly

  Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #bucket ⇒ Bucket
• #initialize ⇒ Object constructor
• #put(options = {}) ⇒ Struct

  Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(bucket_name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

• #initialize(bucket_name, options = {}) ⇒ Object

  Parameters:

  • bucket_name (String)

  Options Hash (options):

  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

• #initialize(options = {}) ⇒ Object

  Options Hash (options):

  • :bucket_name (required, String)
  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#bucket_name ⇒ String (readonly)

Returns:

• (String)

#logging_enabled ⇒ Types::LoggingEnabled (readonly)

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.

Returns:

• (Types::LoggingEnabled) —

  Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.

Instance Method Details

#bucket ⇒ Bucket

Returns:

• (Bucket)

#put(options = {}) ⇒ Struct

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

• By the person's ID:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

  DisplayName is optional and ignored in the request.

• By Email address:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>

  The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

• By URI:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt;

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

• PutObject

• DeleteBucket

• CreateBucket

• GetBucketLogging

Examples:

Request syntax example with placeholder values

bucketlogging.put({
  bucket_logging_status: { # required
    logging_enabled: {
      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
    },
  },
  content_md5: "ContentMD5",
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
})

Options Hash (options):

• :bucket_logging_status (required, Types::BucketLoggingStatus) —

  Container for logging status information.

• :content_md5 (String) —

  The MD5 hash of the PutBucketLogging request body.

  For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

• :expected_bucket_owner (String) —

  The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

• :use_accelerate_endpoint (Boolean) —

  When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#put_bucket_logging