Package software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.CustomOriginConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDistribution.CustomOriginConfigProperty.Jsii$Proxy
Enclosing class:
CfnDistribution
@Stability(Stable) public static interface CfnDistribution.CustomOriginConfigProperty extends software.amazon.jsii.JsiiSerializable
A custom origin.

A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom 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.services.cloudfront.*;
 CustomOriginConfigProperty customOriginConfigProperty = CustomOriginConfigProperty.builder()
         .originProtocolPolicy("originProtocolPolicy")
         // the properties below are optional
         .httpPort(123)
         .httpsPort(123)
         .originKeepaliveTimeout(123)
         .originReadTimeout(123)
         .originSslProtocols(List.of("originSslProtocols"))
         .build();

  • Method Details

    • getOriginProtocolPolicy

      @Stability(Stable) @NotNull String getOriginProtocolPolicy()
      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:.

      • http-only – CloudFront always uses HTTP to connect to the origin.
      • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
      • https-only – CloudFront always uses HTTPS to connect to the origin.

    • getHttpPort

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

      Specify the HTTP port that the origin listens on.

    • getHttpsPort

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

      Specify the HTTPS port that the origin listens on.

    • getOriginKeepaliveTimeout

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

      The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.

      For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .

    • getOriginReadTimeout

      @Stability(Stable) @Nullable default Number getOriginReadTimeout()
      Specifies how long, in seconds, CloudFront waits for a response from the origin.

      This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

      For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .

    • getOriginSslProtocols

      @Stability(Stable) @Nullable default List<String> getOriginSslProtocols()
      Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.

      Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .

      For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .

    • builder

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