Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

interface VpcOriginWithEndpointProps

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.Origins.VpcOriginWithEndpointProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfrontorigins#VpcOriginWithEndpointProps
Javasoftware.amazon.awscdk.services.cloudfront.origins.VpcOriginWithEndpointProps
Pythonaws_cdk.aws_cloudfront_origins.VpcOriginWithEndpointProps
TypeScript (source)aws-cdk-lib » aws_cloudfront_origins » VpcOriginWithEndpointProps

Properties to define a VPC origin with endpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_cloudfront_origins as cloudfront_origins } from 'aws-cdk-lib';
const vpcOriginWithEndpointProps: cloudfront_origins.VpcOriginWithEndpointProps = {
  connectionAttempts: 123,
  connectionTimeout: cdk.Duration.minutes(30),
  customHeaders: {
    customHeadersKey: 'customHeaders',
  },
  domainName: 'domainName',
  httpPort: 123,
  httpsPort: 123,
  keepaliveTimeout: cdk.Duration.minutes(30),
  originAccessControlId: 'originAccessControlId',
  originId: 'originId',
  originPath: 'originPath',
  originShieldEnabled: false,
  originShieldRegion: 'originShieldRegion',
  originSslProtocols: [cloudfront.OriginSslPolicy.SSL_V3],
  protocolPolicy: cloudfront.OriginProtocolPolicy.HTTP_ONLY,
  readTimeout: cdk.Duration.minutes(30),
  vpcOriginName: 'vpcOriginName',
};

Properties

NameTypeDescription
connectionAttempts?numberThe number of times that CloudFront attempts to connect to the origin;
connectionTimeout?DurationThe number of seconds that CloudFront waits when trying to establish a connection to the origin.
customHeaders?{ [string]: string }A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
domainName?stringThe domain name associated with your VPC origin.
httpPort?numberThe HTTP port for the CloudFront VPC origin endpoint configuration.
httpsPort?numberThe HTTPS port of the CloudFront VPC origin endpoint configuration.
keepaliveTimeout?DurationSpecifies how long, in seconds, CloudFront persists its connection to the origin.
originAccessControlId?stringThe unique identifier of an origin access control for this origin.
originId?stringA unique identifier for the origin.
originPath?stringAn optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
originShieldEnabled?booleanOrigin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.
originShieldRegion?stringWhen you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
originSslProtocols?OriginSslPolicy[]A list that contains allowed SSL/TLS protocols for this distribution.
protocolPolicy?OriginProtocolPolicyThe origin protocol policy for the CloudFront VPC origin endpoint configuration.
readTimeout?DurationSpecifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.
vpcOriginName?stringThe name of the CloudFront VPC origin endpoint configuration.

connectionAttempts?

Type: number (optional, default: 3)

The number of times that CloudFront attempts to connect to the origin;

valid values are 1, 2, or 3 attempts.

connectionTimeout?

Type: Duration (optional, default: Duration.seconds(10))

The number of seconds that CloudFront waits when trying to establish a connection to the origin.

Valid values are 1-10 seconds, inclusive.

customHeaders?

Type: { [string]: string } (optional, default: {})

A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.

domainName?

Type: string (optional, default: The default domain name of the endpoint.)

The domain name associated with your VPC origin.

httpPort?

Type: number (optional, default: 80)

The HTTP port for the CloudFront VPC origin endpoint configuration.

httpsPort?

Type: number (optional, default: 443)

The HTTPS port of the CloudFront VPC origin endpoint configuration.

keepaliveTimeout?

Type: Duration (optional, default: Duration.seconds(5))

Specifies how long, in seconds, CloudFront persists its connection to the origin.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

originAccessControlId?

Type: string (optional, default: no origin access control)

The unique identifier of an origin access control for this origin.

originId?

Type: string (optional, default: an originid will be generated for you)

A unique identifier for the origin.

This value must be unique within the distribution.

originPath?

Type: string (optional, default: '/')

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Must begin, but not end, with '/' (e.g., '/production/images').

originShieldEnabled?

Type: boolean (optional, default: true)

Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.

originShieldRegion?

Type: string (optional, default: origin shield not enabled)

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

See also: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html

originSslProtocols?

Type: OriginSslPolicy[] (optional, default: TLSv1.2)

A list that contains allowed SSL/TLS protocols for this distribution.

protocolPolicy?

Type: OriginProtocolPolicy (optional, default: OriginProtocolPolicy.MATCH_VIEWER)

The origin protocol policy for the CloudFront VPC origin endpoint configuration.

readTimeout?

Type: Duration (optional, default: Duration.seconds(30))

Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

vpcOriginName?

Type: string (optional, default: generated from the id)

The name of the CloudFront VPC origin endpoint configuration.

← PreviousNext →