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.106.0 (build e852934)", date="2025-02-26T00:07:34.606Z") @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.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 OriginAccessIdentity originAccessIdentity;
 S3OriginProps s3OriginProps = S3OriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .originAccessControlId("originAccessControlId")
         .originAccessIdentity(originAccessIdentity)
         .originId("originId")
         .originPath("originPath")
         .originShieldEnabled(false)
         .originShieldRegion("originShieldRegion")
         .build();

  • Method Details

    • getOriginAccessIdentity

      @Stability(Stable) @Nullable default IOriginAccessIdentity 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