interface CustomOriginConfigProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudFront.CfnDistribution.CustomOriginConfigProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistribution_CustomOriginConfigProperty |
 Java | software.amazon.awscdk.services.cloudfront.CfnDistribution.CustomOriginConfigProperty |
 Python | aws_cdk.aws_cloudfront.CfnDistribution.CustomOriginConfigProperty |
 TypeScript | aws-cdk-lib » aws_cloudfront » CfnDistribution » CustomOriginConfigProperty |
Obtainable from
Origin.renderCustomOriginConfig(), Function.renderCustomOriginConfig(), Http.renderCustomOriginConfig(), Rest.renderCustomOriginConfig()
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 { 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,
originReadTimeout: 123,
originSslProtocols: ['originSslProtocols'],
};
Properties
| Name | Type | Description |
|---|---|---|
| origin | string | Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:. |
| http | number | The HTTP port that CloudFront uses to connect to the origin. |
| https | number | The HTTPS port that CloudFront uses to connect to the origin. |
| ip | string | Specifies which IP protocol CloudFront uses when connecting to your origin. |
| origin | number | Specifies how long, in seconds, CloudFront persists its connection to the origin. |
| origin | number | Specifies how long, in seconds, CloudFront waits for a response from the origin. |
| origin | string[] | Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. |
originProtocolPolicy
Type:
string
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.
httpPort?
Type:
number
(optional, default: 80)
The HTTP port that CloudFront uses to connect to the origin.
Specify the HTTP port that the origin listens on.
httpsPort?
Type:
number
(optional, default: 443)
The HTTPS port that CloudFront uses to connect to the origin.
Specify the HTTPS port that the origin listens on.
ipAddressType?
Type:
string
(optional)
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?
Type:
number
(optional, default: 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) in the Amazon CloudFront Developer Guide .
originReadTimeout?
Type:
number
(optional, default: 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 in the Amazon CloudFront Developer Guide .
originSslProtocols?
Type:
string[]
(optional)
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 .