software.amazon.awscdk.services.cloudfront.origins

Interface HttpOriginProps

All Superinterfaces:

OriginOptions, OriginProps

All Known Subinterfaces:

LoadBalancerV2OriginProps

All Known Implementing Classes:

HttpOriginProps.Jsii$Proxy, LoadBalancerV2OriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.723Z")
public interface HttpOriginProps
extends OriginProps

Properties for an Origin backed by an S3 website-configured bucket, load balancer, or custom HTTP server.

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.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 import software.amazon.awscdk.core.*;
 HttpOriginProps httpOriginProps = HttpOriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .httpPort(123)
         .httpsPort(123)
         .keepaliveTimeout(Duration.minutes(30))
         .originPath("originPath")
         .originShieldRegion("originShieldRegion")
         .originSslProtocols(List.of(OriginSslPolicy.SSL_V3))
         .protocolPolicy(OriginProtocolPolicy.HTTP_ONLY)
         .readTimeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HttpOriginProps.Builder	builder()
default java.lang.Number	getHttpPort() The HTTP port that CloudFront uses to connect to the origin.
default java.lang.Number	getHttpsPort() The HTTPS port that CloudFront uses to connect to the origin.
default Duration	getKeepaliveTimeout() Specifies how long, in seconds, CloudFront persists its connection to the origin.
default java.util.List<OriginSslPolicy>	getOriginSslProtocols() The SSL versions to use when interacting with the origin.
default OriginProtocolPolicy	getProtocolPolicy() Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
default Duration	getReadTimeout() Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

Methods inherited from interface software.amazon.awscdk.services.cloudfront.OriginProps

getOriginPath

Methods inherited from interface software.amazon.awscdk.services.cloudfront.OriginOptions

getConnectionAttempts, getConnectionTimeout, getCustomHeaders, getOriginShieldRegion

Method Detail

getHttpPort

default java.lang.Number getHttpPort()

The HTTP port that CloudFront uses to connect to the origin.

Default: 80

getHttpsPort

default java.lang.Number getHttpsPort()

The HTTPS port that CloudFront uses to connect to the origin.

Default: 443

getKeepaliveTimeout

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

default java.util.List<OriginSslPolicy> getOriginSslProtocols()

The SSL versions to use when interacting with the origin.

Default: OriginSslPolicy.TLS_V1_2

getProtocolPolicy

default OriginProtocolPolicy getProtocolPolicy()

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

Default: OriginProtocolPolicy.HTTPS_ONLY

getReadTimeout

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

static HttpOriginProps.Builder builder()

Specified by:

builder in interface OriginOptions

Specified by:

builder in interface OriginProps

Returns:

a HttpOriginProps.Builder of HttpOriginProps