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

Interface HttpOriginProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, OriginOptions, OriginProps
All Known Subinterfaces:
LoadBalancerV2OriginProps, S3StaticWebsiteOriginProps
All Known Implementing Classes:
HttpOriginProps.Jsii$Proxy, LoadBalancerV2OriginProps.Jsii$Proxy, S3StaticWebsiteOriginProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-17T14:40:47.175Z") @Stability(Stable) public interface HttpOriginProps extends software.amazon.jsii.JsiiSerializable, OriginProps
Properties for an Origin backed by an S3 website-configured bucket, load balancer, or custom HTTP server.

Example: 

 HttpOrigin origin = HttpOrigin.Builder.create("www.example.com")
         .ipAddressType(OriginIpAddressType.IPV6)
         .build();
 Distribution.Builder.create(this, "Distribution")
         .defaultBehavior(BehaviorOptions.builder().origin(origin).build())
         .build();

  • Method Details

    • getHttpPort

      @Stability(Stable) @Nullable default Number getHttpPort()
      The HTTP port that CloudFront uses to connect to the origin.

      Default: 80

    • getHttpsPort

      @Stability(Stable) @Nullable default Number getHttpsPort()
      The HTTPS port that CloudFront uses to connect to the origin.

      Default: 443

    • getIpAddressType

      @Stability(Stable) @Nullable default OriginIpAddressType getIpAddressType()
      Specifies which IP protocol CloudFront uses when connecting to your origin.

      If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

      Default: undefined - AWS Cloudfront default is IPv4

    • getKeepaliveTimeout

      @Stability(Stable) @Nullable default Duration getKeepaliveTimeout()
      Specifies how long, in seconds, CloudFront persists its connection to the origin.

      The valid range is from 1 to 180 seconds, inclusive.

      Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

      Default: Duration.seconds(5)

    • getOriginSslProtocols

      @Stability(Stable) @Nullable default List<OriginSslPolicy> getOriginSslProtocols()
      The SSL versions to use when interacting with the origin.

      Default: OriginSslPolicy.TLS_V1_2

    • getProtocolPolicy

      @Stability(Stable) @Nullable default OriginProtocolPolicy getProtocolPolicy()
      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

      Default: OriginProtocolPolicy.HTTPS_ONLY

    • getReadTimeout

      @Stability(Stable) @Nullable default Duration getReadTimeout()
      Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

      The valid range is from 1 to 180 seconds, inclusive.

      Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

      Default: Duration.seconds(30)

    • builder

      @Stability(Stable) static HttpOriginProps.Builder builder()
      Returns:
      a HttpOriginProps.Builder of HttpOriginProps