Class: Aws::S3::Types::PutBucketAclRequest

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

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read
  access_control_policy: {
    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, WRITE, WRITE_ACP, READ, READ_ACP
      },
    ],
    owner: {
      display_name: "DisplayName",
      id: "ID",
    },
  },
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_policyTypes::AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#aclString

The canned ACL to apply to the bucket.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#bucketString

The bucket to which to apply the ACL.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5String

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to [RFC 1864.]

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

[1]: www.ietf.org/rfc/rfc1864.txt

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :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)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#grant_full_controlString

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#grant_readString

Allows grantee to list the objects in the bucket.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#grant_read_acpString

Allows grantee to read the bucket ACL.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#grant_writeString

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#grant_write_acpString

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String)

10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/aws-sdk-s3/types.rb', line 10243

class PutBucketAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end