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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  The name of the bucket.

• #checksum_algorithm ⇒ String

  Indicates the algorithm used to create the checksum for the object when using the SDK.

• #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 10319

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

#checksum_algorithm ⇒ String

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.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

• (String)

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

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_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 10319

class PutBucketPolicyRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :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 Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

• (String)

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

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_owner ⇒ String

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)

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

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

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