interface OriginProps

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

Properties to define an Origin.

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';
const originProps: cloudfront.OriginProps = {
  connectionAttempts: 123,
  connectionTimeout: cdk.Duration.minutes(30),
  customHeaders: {
    customHeadersKey: 'customHeaders',
  },
  originAccessControlId: 'originAccessControlId',
  originId: 'originId',
  originPath: 'originPath',
  originShieldEnabled: false,
  originShieldRegion: 'originShieldRegion',
};

Properties

Name	Type	Description
connectionAttempts?	`number`	The number of times that CloudFront attempts to connect to the origin;
connectionTimeout?	`Duration`	The 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.
originAccessControlId?	`string`	The unique identifier of an origin access control for this origin.
originId?	`string`	A unique identifier for the origin.
originPath?	`string`	An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
originShieldEnabled?	`boolean`	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?	`string`	When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

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.

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.