Package software.amazon.awscdk.services.cloudfront.origins

Interface S3BucketOriginWithOACProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions, OriginProps, S3BucketOriginBaseProps

All Known Implementing Classes:

S3BucketOriginWithOACProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:08.734Z")
@Stability(Stable)
public interface S3BucketOriginWithOACProps
extends software.amazon.jsii.JsiiSerializable, S3BucketOriginBaseProps

Properties for configuring a S3 origin with OAC.

Example:

 Bucket myBucket = new Bucket(this, "myBucket");
 IOrigin s3Origin = S3BucketOrigin.withOriginAccessControl(myBucket, S3BucketOriginWithOACProps.builder()
         .originAccessLevels(List.of(AccessLevel.READ, AccessLevel.LIST))
         .build());
 Distribution.Builder.create(this, "distribution")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(s3Origin)
                 .build())
         .defaultRootObject("index.html")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	S3BucketOriginWithOACProps.Builder	A builder for S3BucketOriginWithOACProps
static final class	S3BucketOriginWithOACProps.Jsii$Proxy	An implementation for S3BucketOriginWithOACProps

Method Summary

Modifier and Type	Method	Description
static S3BucketOriginWithOACProps.Builder	builder()
default IOriginAccessControl	getOriginAccessControl()	An optional Origin Access Control.
default List<AccessLevel>	getOriginAccessLevels()	The level of permissions granted in the bucket policy and key policy (if applicable) to the CloudFront distribution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cloudfront.OriginOptions

getConnectionAttempts, getConnectionTimeout, getCustomHeaders, getOriginAccessControlId, getOriginId, getOriginShieldEnabled, getOriginShieldRegion

Methods inherited from interface software.amazon.awscdk.services.cloudfront.OriginProps

getOriginPath

Method Details

getOriginAccessControl

@Stability(Stable)
@Nullable
default IOriginAccessControl getOriginAccessControl()

An optional Origin Access Control.

Default: - an Origin Access Control will be created.

getOriginAccessLevels

@Stability(Stable)
@Nullable
default List<AccessLevel> getOriginAccessLevels()

The level of permissions granted in the bucket policy and key policy (if applicable) to the CloudFront distribution.

Default: [AccessLevel.READ]

builder

@Stability(Stable)
static S3BucketOriginWithOACProps.Builder builder()

Returns:

a S3BucketOriginWithOACProps.Builder of S3BucketOriginWithOACProps