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

Interface S3OriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions, OriginProps

All Known Implementing Classes:

S3OriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:07.091Z")
@Stability(Stable)
public interface S3OriginProps
extends software.amazon.jsii.JsiiSerializable, OriginProps

Properties to use to customize an S3 Origin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.interfaces.cloudfront.*;
 ICloudFrontOriginAccessIdentityRef /* & IGrantable */ cloudFrontOriginAccessIdentityRef;
 S3OriginProps s3OriginProps = S3OriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .originAccessControlId("originAccessControlId")
         .originAccessIdentity(cloudFrontOriginAccessIdentityRef)
         .originId("originId")
         .originPath("originPath")
         .originShieldEnabled(false)
         .originShieldRegion("originShieldRegion")
         .responseCompletionTimeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3OriginProps.Builder	builder()
default ICloudFrontOriginAccessIdentityRef	getOriginAccessIdentity()	An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.

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 ICloudFrontOriginAccessIdentityRef getOriginAccessIdentity()

An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.

Default: - An Origin Access Identity will be created.

builder

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

Returns:

a S3OriginProps.Builder of S3OriginProps