Package software.amazon.awssdk.services.s3.model

Enum ObjectOwnership

java.lang.Object
java.lang.Enum<ObjectOwnership>
software.amazon.awssdk.services.s3.model.ObjectOwnership
All Implemented Interfaces:
Serializable, Comparable<ObjectOwnership>
@Generated("software.amazon.awssdk:codegen") public enum ObjectOwnership extends Enum<ObjectOwnership>

The container element for object ownership for a bucket's ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

  • Enum Constant Details

    • BUCKET_OWNER_PREFERRED

      public static final ObjectOwnership BUCKET_OWNER_PREFERRED

    • OBJECT_WRITER

      public static final ObjectOwnership OBJECT_WRITER

    • BUCKET_OWNER_ENFORCED

      public static final ObjectOwnership BUCKET_OWNER_ENFORCED

    • UNKNOWN_TO_SDK_VERSION

      public static final ObjectOwnership UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static ObjectOwnership[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ObjectOwnership valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ObjectOwnership>

    • fromValue

      public static ObjectOwnership fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      ObjectOwnership corresponding to the value

    • knownValues

      public static Set<ObjectOwnership> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known ObjectOwnerships