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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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)


12042
12043
12044
12045
12046
12047
12048
12049
12050
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12042

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

#bucket_logging_statusTypes::BucketLoggingStatus

Container for logging status information.



12042
12043
12044
12045
12046
12047
12048
12049
12050
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12042

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

#checksum_algorithmString

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

  • (String)


12042
12043
12044
12045
12046
12047
12048
12049
12050
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12042

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

#content_md5String

The MD5 hash of the PutBucketLogging request body.

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

Returns:

  • (String)


12042
12043
12044
12045
12046
12047
12048
12049
12050
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12042

class PutBucketLoggingRequest < Struct.new(
  :bucket,
  :bucket_logging_status,
  :content_md5,
  :checksum_algorithm,
  :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 fails with the HTTP status code 403 Forbidden (access denied).

Returns:

  • (String)


12042
12043
12044
12045
12046
12047
12048
12049
12050
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12042

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