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.139.0 (build 26a6b54)", date="2026-09-02T11:03:05.664Z") @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 minimum is 1 second. The maximum is governed by the keep-alive timeout per origin quota, which is adjustable, so the effective maximum depends on the target account.

      The default quota allows up to 300 seconds; higher values require an approved limit increase in the target account, and otherwise 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 minimum is 1 second. The maximum is governed by the origin response timeout quota, which is adjustable, so the effective maximum depends on the target account.

      The default quota allows up to 120 seconds; higher values require an approved limit increase in the target account, and otherwise produce an error at deploy time.

      Default: Duration.seconds(30)

    • builder

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