com.ibm.cloud.objectstorage.services.s3.model

Enum CannedAccessControlList

java.lang.Object

java.lang.Enum<CannedAccessControlList>

com.ibm.cloud.objectstorage.services.s3.model.CannedAccessControlList

All Implemented Interfaces:

Serializable, Comparable<CannedAccessControlList>

public enum CannedAccessControlList
extends Enum<CannedAccessControlList>

Specifies constants defining a canned access control list.

Canned access control lists are commonly used access control lists (ACL) that can be used as a shortcut when applying an access control list to Amazon S3 buckets and objects. Only a few commonly used configurations are available, but they offer an alternative to manually creating a custom ACL. If more specific access control is desired, users can create a custom AccessControlList.

See Also:

AccessControlList

Enum Constant Summary

Enum Constants

Enum Constant and Description
AuthenticatedRead Specifies the owner is granted Permission.FullControl and the GroupGrantee.AuthenticatedUsers group grantee is granted Permission.Read access.
AwsExecRead Specifies the owner is granted Permission.FullControl.
BucketOwnerFullControl Specifies the owner of the bucket, but not necessarily the same as the owner of the object, is granted Permission.FullControl.
BucketOwnerRead Specifies the owner of the bucket, but not necessarily the same as the owner of the object, is granted Permission.Read.
LogDeliveryWrite Specifies the owner is granted Permission.FullControl and the GroupGrantee.LogDelivery group grantee is granted Permission.Write access so that access logs can be delivered.
Private Specifies the owner is granted Permission.FullControl.
PublicRead Specifies the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read access.
PublicReadWrite Specifies the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read and Permission.Write access.

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the Amazon S3 x-amz-acl header value for this canned acl.
static CannedAccessControlList	valueOf(String name) Returns the enum constant of this type with the specified name.
static CannedAccessControlList[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Private

public static final CannedAccessControlList Private

Specifies the owner is granted Permission.FullControl. No one else has access rights.

This is the default access control policy for any new buckets or objects.

PublicRead

public static final CannedAccessControlList PublicRead

Specifies the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read access.

If this policy is used on an object, it can be read from a browser without authentication.

PublicReadWrite

public static final CannedAccessControlList PublicReadWrite

Specifies the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read and Permission.Write access.

This access policy is not recommended for general use.

AuthenticatedRead

public static final CannedAccessControlList AuthenticatedRead

Specifies the owner is granted Permission.FullControl and the GroupGrantee.AuthenticatedUsers group grantee is granted Permission.Read access.

LogDeliveryWrite

public static final CannedAccessControlList LogDeliveryWrite

Specifies the owner is granted Permission.FullControl and the GroupGrantee.LogDelivery group grantee is granted Permission.Write access so that access logs can be delivered.

Use this access policy to enable Amazon S3 bucket logging for a bucket. The destination bucket requires these permissions so that access logs can be delivered.

BucketOwnerRead

public static final CannedAccessControlList BucketOwnerRead

Specifies the owner of the bucket, but not necessarily the same as the owner of the object, is granted Permission.Read.

Use this access policy when uploading objects to another owner's bucket. This access policy grants the bucket owner read access to the object, but does not give read access for all users.

BucketOwnerFullControl

public static final CannedAccessControlList BucketOwnerFullControl

Specifies the owner of the bucket, but not necessarily the same as the owner of the object, is granted Permission.FullControl.

Use this access policy to upload objects to another owner's bucket. This access policy grants the bucket owner full access to the object, but does not give full access to all users.

AwsExecRead

public static final CannedAccessControlList AwsExecRead

Specifies the owner is granted Permission.FullControl. Amazon EC2 is granted Permission.Read access to GET an Amazon Machine Image (AMI) bundle from Amazon S3.

Method Detail

values

public static CannedAccessControlList[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CannedAccessControlList c : CannedAccessControlList.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CannedAccessControlList 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()

Returns the Amazon S3 x-amz-acl header value for this canned acl.

Overrides:

toString in class Enum<CannedAccessControlList>