Class: Aws::S3::Types::PutBucketLoggingRequest

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 PutBucketLoggingRequest data as a hash:

{
  bucket: "BucketName", # required
  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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The name of the bucket for which to set the logging parameters.

Returns:

  • (String)


10613
10614
10615
10616
10617
10618
10619
10620
# File 'lib/aws-sdk-s3/types.rb', line 10613

class PutBucketLoggingRequest < Struct.new(
  :bucket,
  :bucket_logging_status,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_logging_statusTypes::BucketLoggingStatus

Container for logging status information.



10613
10614
10615
10616
10617
10618
10619
10620
# File 'lib/aws-sdk-s3/types.rb', line 10613

class PutBucketLoggingRequest < Struct.new(
  :bucket,
  :bucket_logging_status,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5String

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.

Returns:

  • (String)


10613
10614
10615
10616
10617
10618
10619
10620
# File 'lib/aws-sdk-s3/types.rb', line 10613

class PutBucketLoggingRequest < Struct.new(
  :bucket,
  :bucket_logging_status,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

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.

Returns:

  • (String)


10613
10614
10615
10616
10617
10618
10619
10620
# File 'lib/aws-sdk-s3/types.rb', line 10613

class PutBucketLoggingRequest < Struct.new(
  :bucket,
  :bucket_logging_status,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end