Class: Aws::S3::Types::PutBucketPolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutBucketPolicyRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutBucketPolicyRequest data as a hash:

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  confirm_remove_self_bucket_access: false,
  policy: "Policy", # required
  expected_bucket_owner: "AccountId",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  The name of the bucket.

• #confirm_remove_self_bucket_access ⇒ Boolean

  Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

• #content_md5 ⇒ String

  The MD5 hash of the request body.

• #expected_bucket_owner ⇒ String

  The account id of the expected bucket owner.

• #policy ⇒ String

  The bucket policy as a JSON document.

Instance Attribute Details

#bucket ⇒ String

The name of the bucket.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10917

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

#confirm_remove_self_bucket_access ⇒ Boolean

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

Returns:

• (Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 10917

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

#content_md5 ⇒ String

The MD5 hash of the request body.

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10917

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

#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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10917

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

#policy ⇒ String

The bucket policy as a JSON document.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10917

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