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

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

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  confirm_remove_self_bucket_access: false,
  policy: "Policy", # required
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The name of the bucket.

Returns:

  • (String)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

class PutBucketPolicyRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :confirm_remove_self_bucket_access,
  :policy,
  :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)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

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

#confirm_remove_self_bucket_accessBoolean

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

Returns:

  • (Boolean)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

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

#content_md5String

The MD5 hash of the 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)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

class PutBucketPolicyRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :confirm_remove_self_bucket_access,
  :policy,
  :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)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

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

#policyString

The bucket policy as a JSON document.

Returns:

  • (String)


12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12398

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