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

Interface S3BucketOriginWithOAIProps

All Superinterfaces:

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

All Known Implementing Classes:

S3BucketOriginWithOAIProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:06.675Z")
@Stability(Stable)
public interface S3BucketOriginWithOAIProps
extends software.amazon.jsii.JsiiSerializable, S3BucketOriginBaseProps

Properties for configuring a S3 origin with OAI.

Example:

 Bucket myBucket = new Bucket(this, "myBucket");
 OriginAccessIdentity myOai = OriginAccessIdentity.Builder.create(this, "myOAI")
         .comment("My custom OAI")
         .build();
 IOrigin s3Origin = S3BucketOrigin.withOriginAccessIdentity(myBucket, S3BucketOriginWithOAIProps.builder()
         .originAccessIdentity(myOai)
         .build());
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(s3Origin)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3BucketOriginWithOAIProps.Builder	builder()
default IOriginAccessIdentity	getOriginAccessIdentity()	An optional Origin Access Identity.

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, getResponseCompletionTimeout

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

getOriginPath

Method Details

getOriginAccessIdentity

@Stability(Stable)
@Nullable
default IOriginAccessIdentity getOriginAccessIdentity()

An optional Origin Access Identity.

Default: - an Origin Access Identity will be created.

builder

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

Returns:

a S3BucketOriginWithOAIProps.Builder of S3BucketOriginWithOAIProps