Package software.amazon.awscdk.services.cloudfront

Interface OriginAccessIdentityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginAccessIdentityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:00.601Z")
@Stability(Stable)
public interface OriginAccessIdentityProps
extends software.amazon.jsii.JsiiSerializable

Properties of CloudFront OriginAccessIdentity.

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	OriginAccessIdentityProps.Builder	A builder for OriginAccessIdentityProps
static final class	OriginAccessIdentityProps.Jsii$Proxy	An implementation for OriginAccessIdentityProps

Method Summary

Modifier and Type	Method	Description
static OriginAccessIdentityProps.Builder	builder()
default String	getComment()	Any comments you want to include about the origin access identity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

@Stability(Stable)
@Nullable
default String getComment()

Any comments you want to include about the origin access identity.

Default: "Allows CloudFront to reach the bucket"

builder

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

Returns:

a OriginAccessIdentityProps.Builder of OriginAccessIdentityProps