software.amazon.awscdk.services.s3

Enum BucketAccessControl

java.lang.Object

java.lang.Enum<BucketAccessControl>

software.amazon.awscdk.services.s3.BucketAccessControl

All Implemented Interfaces:

Serializable, Comparable<BucketAccessControl>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.731Z")
 @Stability(value=Stable)
public enum BucketAccessControl
extends Enum<BucketAccessControl>

Default bucket access control types.

Example:

 Bucket websiteBucket = Bucket.Builder.create(this, "WebsiteBucket")
         .websiteIndexDocument("index.html")
         .publicReadAccess(true)
         .build();
 BucketDeployment.Builder.create(this, "DeployWebsite")
         .sources(List.of(Source.asset("./website-dist")))
         .destinationBucket(websiteBucket)
         .destinationKeyPrefix("web/static") // optional prefix in destination bucket
         .metadata(UserDefinedObjectMetadata.builder().A("1").b("2").build()) // user-defined metadata
         // system-defined metadata
         .contentType("text/html")
         .contentLanguage("en")
         .storageClass(StorageClass.INTELLIGENT_TIERING)
         .serverSideEncryption(ServerSideEncryption.AES_256)
         .cacheControl(List.of(CacheControl.setPublic(), CacheControl.maxAge(Duration.hours(1))))
         .accessControl(BucketAccessControl.BUCKET_OWNER_FULL_CONTROL)
         .build();
 

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATED_READ Owner gets FULL_CONTROL.
AWS_EXEC_READ Owner gets FULL_CONTROL.
BUCKET_OWNER_FULL_CONTROL Both the object owner and the bucket owner get FULL_CONTROL over the object.
BUCKET_OWNER_READ Object owner gets FULL_CONTROL.
LOG_DELIVERY_WRITE The LogDelivery group gets WRITE and READ_ACP permissions on the bucket.
PRIVATE Owner gets FULL_CONTROL.
PUBLIC_READ Owner gets FULL_CONTROL.
PUBLIC_READ_WRITE Owner gets FULL_CONTROL.

Method Summary

Modifier and Type	Method and Description
static BucketAccessControl	valueOf(String name) Returns the enum constant of this type with the specified name.
static BucketAccessControl[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRIVATE

@Stability(value=Stable)
public static final BucketAccessControl PRIVATE

Owner gets FULL_CONTROL.

No one else has access rights.

PUBLIC_READ

@Stability(value=Stable)
public static final BucketAccessControl PUBLIC_READ

Owner gets FULL_CONTROL.

The AllUsers group gets READ access.

PUBLIC_READ_WRITE

@Stability(value=Stable)
public static final BucketAccessControl PUBLIC_READ_WRITE

Owner gets FULL_CONTROL.

The AllUsers group gets READ and WRITE access. Granting this on a bucket is generally not recommended.

AUTHENTICATED_READ

@Stability(value=Stable)
public static final BucketAccessControl AUTHENTICATED_READ

Owner gets FULL_CONTROL.

The AuthenticatedUsers group gets READ access.

LOG_DELIVERY_WRITE

@Stability(value=Stable)
public static final BucketAccessControl LOG_DELIVERY_WRITE

The LogDelivery group gets WRITE and READ_ACP permissions on the bucket.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html

BUCKET_OWNER_READ

@Stability(value=Stable)
public static final BucketAccessControl BUCKET_OWNER_READ

Object owner gets FULL_CONTROL.

Bucket owner gets READ access. If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.

BUCKET_OWNER_FULL_CONTROL

@Stability(value=Stable)
public static final BucketAccessControl BUCKET_OWNER_FULL_CONTROL

Both the object owner and the bucket owner get FULL_CONTROL over the object.

If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.

AWS_EXEC_READ

@Stability(value=Stable)
public static final BucketAccessControl AWS_EXEC_READ

Owner gets FULL_CONTROL.

Amazon EC2 gets READ access to GET an Amazon Machine Image (AMI) bundle from Amazon S3.

Method Detail

values

public static BucketAccessControl[] 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 (BucketAccessControl c : BucketAccessControl.values())
    System.out.println(c);

Returns:

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

valueOf

public static BucketAccessControl 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