# CustomOriginConfigProperty

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](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.

- Source: Generated at build time
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

TypeScript:

```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'],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

custom_origin_config_property = cloudfront.CfnDistribution.CustomOriginConfigProperty(
    origin_protocol_policy="originProtocolPolicy",

    # the properties below are optional
    http_port=123,
    https_port=123,
    ip_address_type="ipAddressType",
    origin_keepalive_timeout=123,
    origin_mtls_config=cloudfront.CfnDistribution.OriginMtlsConfigProperty(
        client_certificate_arn="clientCertificateArn"
    ),
    origin_read_timeout=123,
    origin_ssl_protocols=["originSslProtocols"]
)
```

Java:

```java
// 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)
        .ipAddressType("ipAddressType")
        .originKeepaliveTimeout(123)
        .originMtlsConfig(OriginMtlsConfigProperty.builder()
                .clientCertificateArn("clientCertificateArn")
                .build())
        .originReadTimeout(123)
        .originSslProtocols(List.of("originSslProtocols"))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var customOriginConfigProperty = new CustomOriginConfigProperty {
    OriginProtocolPolicy = "originProtocolPolicy",

    // the properties below are optional
    HttpPort = 123,
    HttpsPort = 123,
    IpAddressType = "ipAddressType",
    OriginKeepaliveTimeout = 123,
    OriginMtlsConfig = new OriginMtlsConfigProperty {
        ClientCertificateArn = "clientCertificateArn"
    },
    OriginReadTimeout = 123,
    OriginSslProtocols = new [] { "originSslProtocols" }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

customOriginConfigProperty := &CustomOriginConfigProperty{
	OriginProtocolPolicy: jsii.String("originProtocolPolicy"),

	// the properties below are optional
	HttpPort: jsii.Number(123),
	HttpsPort: jsii.Number(123),
	IpAddressType: jsii.String("ipAddressType"),
	OriginKeepaliveTimeout: jsii.Number(123),
	OriginMtlsConfig: &OriginMtlsConfigProperty{
		ClientCertificateArn: jsii.String("clientCertificateArn"),
	},
	OriginReadTimeout: jsii.Number(123),
	OriginSslProtocols: []*string{
		jsii.String("originSslProtocols"),
	},
}
```

## Properties

- `httpPort`: number = 80 — The HTTP port that CloudFront uses to connect to the origin.

  Specify the HTTP port that the origin listens on.

- `httpsPort`: number = 443 — The HTTPS port that CloudFront uses to connect to the origin.

  Specify the HTTPS port that the origin listens on.

- `ipAddressType`: 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.

- `originKeepaliveTimeout`: number = 5 — Specifies how long, in seconds, CloudFront persists its connection to the origin.

  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)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide* .

- `originMtlsConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDistribution.OriginMtlsConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront.CfnDistribution.OriginMtlsConfigProperty.html) — Configures mutual TLS authentication between CloudFront and your origin server.

- `originProtocolPolicy`: string (required) — 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.

- `originReadTimeout`: number = 30 — 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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

  For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide* .

- `originSslProtocols`: string[] — 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide* .
