interface VpcOriginConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.CfnDistribution.VpcOriginConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistribution_VpcOriginConfigProperty`
Java	`software.amazon.awscdk.services.cloudfront.CfnDistribution.VpcOriginConfigProperty`
Python	`aws_cdk.aws_cloudfront.CfnDistribution.VpcOriginConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudfront` » `CfnDistribution` » `VpcOriginConfigProperty`

Obtainable from OriginBase.renderVpcOriginConfig(), VpcOrigin.renderVpcOriginConfig()

An Amazon CloudFront VPC origin configuration.

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 vpcOriginConfigProperty: cloudfront.CfnDistribution.VpcOriginConfigProperty = {
  vpcOriginId: 'vpcOriginId',

  // the properties below are optional
  originKeepaliveTimeout: 123,
  originReadTimeout: 123,
};

Properties

Name	Type	Description
vpcOriginId	`string`	The VPC origin ID.
originKeepaliveTimeout?	`number`	Specifies how long, in seconds, CloudFront persists its connection to the origin.
originReadTimeout?	`number`	Specifies how long, in seconds, CloudFront waits for a response from the origin.

vpcOriginId

Type: string

The VPC origin ID.

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 .