Skip to content
v2.278.0

VpcOriginConfigProperty Struct ​

An Amazon CloudFront VPC origin configuration.

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

  // the properties below are optional
  originKeepaliveTimeout: 123,
  originReadTimeout: 123,
  ownerAccountId: 'ownerAccountId',
};
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

vpc_origin_config_property = cloudfront.CfnDistribution.VpcOriginConfigProperty(
    vpc_origin_id="vpcOriginId",

    # the properties below are optional
    origin_keepalive_timeout=123,
    origin_read_timeout=123,
    owner_account_id="ownerAccountId"
)
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.*;

VpcOriginConfigProperty vpcOriginConfigProperty = VpcOriginConfigProperty.builder()
        .vpcOriginId("vpcOriginId")

        // the properties below are optional
        .originKeepaliveTimeout(123)
        .originReadTimeout(123)
        .ownerAccountId("ownerAccountId")
        .build();
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 vpcOriginConfigProperty = new VpcOriginConfigProperty {
    VpcOriginId = "vpcOriginId",

    // the properties below are optional
    OriginKeepaliveTimeout = 123,
    OriginReadTimeout = 123,
    OwnerAccountId = "ownerAccountId"
};
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"

vpcOriginConfigProperty := &VpcOriginConfigProperty{
	VpcOriginId: jsii.String("vpcOriginId"),

	// the properties below are optional
	OriginKeepaliveTimeout: jsii.Number(123),
	OriginReadTimeout: jsii.Number(123),
	OwnerAccountId: jsii.String("ownerAccountId"),
}

Properties ​

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 .

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 .

ownerAccountIdoptionalstringowner_account_idoptionalstrownerAccountIdoptionalStringOwnerAccountIdoptionalstringOwnerAccountIdoptional*string #
The account ID of the AWS account that owns the VPC origin.
vpcOriginIdstringvpc_origin_idstrvpcOriginIdStringVpcOriginIdstringVpcOriginId*string required #
The VPC origin ID.