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

Class: Aws::S3::Types::PutObjectAclRequest

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

Overview

Note:

When passing PutObjectAclRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  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",
  key: "ObjectKey", # required
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_policyTypes::AccessControlPolicy

#aclString

The canned ACL to apply to the object.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • aws-exec-read
  • bucket-owner-read
  • bucket-owner-full-control

Returns:

  • (String)

    The canned ACL to apply to the object.

#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.

#keyString

Returns:

  • (String)

#request_payerString

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Possible values:

  • requester

Returns:

  • (String)

    Confirms that the requester knows that she or he will be charged for the request.

#use_accelerate_endpointBoolean

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

Returns:

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)

    VersionId used to reference a specific version of the object.