You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_policyTypes::AccessControlPolicy



5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#aclString

The canned ACL to apply to the bucket.

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#bucketString

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#content_md5String

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#grant_full_controlString

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

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#grant_readString

Allows grantee to list the objects in the bucket.

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#grant_read_acpString

Allows grantee to read the bucket ACL.

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#grant_writeString

Allows grantee to create, overwrite, and delete any object in the bucket.

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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

#grant_write_acpString

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String)


5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5815

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