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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutBucketAclRequest as input to an Aws::Client method, you can use a vanilla 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",
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_policyTypes::AccessControlPolicy

#aclString

The canned ACL to apply to the bucket.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read

Returns:

  • (String)

    The canned ACL to apply to the bucket.

#bucketString

Returns:

  • (String)

#content_md5String

Returns:

  • (String)

#grant_full_controlString

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

Returns:

  • (String)

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

#grant_readString

Allows grantee to list the objects in the bucket.

Returns:

  • (String)

    Allows grantee to list the objects in the bucket.

#grant_read_acpString

Allows grantee to read the bucket ACL.

Returns:

  • (String)

    Allows grantee to read the bucket ACL.

#grant_writeString

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

Returns:

  • (String)

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

#grant_write_acpString

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String)

    Allows grantee to write the ACL for the applicable bucket.

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns: