AWS CDK Reference

Appearance

v2.274.0

CustomOriginConfigProperty Struct ​

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.

Source
Generated code
Type last changed
v2.234.0 · 8 Jan 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const customOriginConfigProperty: cloudfront.CfnDistribution.CustomOriginConfigProperty = {
  originProtocolPolicy: 'originProtocolPolicy',

  // the properties below are optional
  httpPort: 123,
  httpsPort: 123,
  ipAddressType: 'ipAddressType',
  originKeepaliveTimeout: 123,
  originMtlsConfig: {
    clientCertificateArn: 'clientCertificateArn',
  },
  originReadTimeout: 123,
  originSslProtocols: ['originSslProtocols'],
};

Properties ​

httpPortoptionalnumberhttp_portoptionalint | floathttpPortoptionalNumberHttpPortoptionaldoubleHttpPortoptional*float64= 80#
The HTTP port that CloudFront uses to connect to the origin.

Specify the HTTP port that the origin listens on.

httpsPortoptionalnumberhttps_portoptionalint | floathttpsPortoptionalNumberHttpsPortoptionaldoubleHttpsPortoptional*float64= 443#
The HTTPS port that CloudFront uses to connect to the origin.

Specify the HTTPS port that the origin listens on.

ipAddressTypeoptionalstringip_address_typeoptionalstripAddressTypeoptionalStringIpAddressTypeoptionalstringIpAddressTypeoptional*string#
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.

originKeepaliveTimeoutoptionalnumberorigin_keepalive_timeoutoptionalint | floatoriginKeepaliveTimeoutoptionalNumberOriginKeepaliveTimeoutoptionaldoubleOriginKeepaliveTimeoutoptional*float64= 5#
Specifies how long, in seconds, CloudFront persists its connection to the origin.
notes

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

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide .

originMtlsConfigoptionalIResolvable | CfnDistribution.OriginMtlsConfigPropertyorigin_mtls_configoptionaltyping.Union[IResolvable, OriginMtlsConfigProperty]originMtlsConfigoptionalIResolvableOriginMtlsConfigoptionalIResolvableOriginMtlsConfigoptionalinterface{}#
Configures mutual TLS authentication between CloudFront and your origin server.
originProtocolPolicystringorigin_protocol_policystroriginProtocolPolicyStringOriginProtocolPolicystringOriginProtocolPolicy*stringrequired#
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:.
notes
  • 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.
originReadTimeoutoptionalnumberorigin_read_timeoutoptionalint | floatoriginReadTimeoutoptionalNumberOriginReadTimeoutoptionaldoubleOriginReadTimeoutoptional*float64= 30#
Specifies how long, in seconds, CloudFront waits for a response from the origin.
notes

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

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

originSslProtocolsoptionalstring[]origin_ssl_protocolsoptionaltyping.List[str]originSslProtocolsoptionalList<String>OriginSslProtocolsoptionalstring[]OriginSslProtocolsoptional*[]*string#
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.
notes

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

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