interface OriginProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudFront.OriginProps |
![]() | software.amazon.awscdk.services.cloudfront.OriginProps |
![]() | aws_cdk.aws_cloudfront.OriginProps |
![]() | @aws-cdk/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 cloudfront from '@aws-cdk/aws-cloudfront';
import * as cdk from '@aws-cdk/core';
const originProps: cloudfront.OriginProps = {
connectionAttempts: 123,
connectionTimeout: cdk.Duration.minutes(30),
customHeaders: {
customHeadersKey: 'customHeaders',
},
originPath: 'originPath',
originShieldRegion: 'originShieldRegion',
};
Properties
Name | Type | Description |
---|---|---|
connection | number | The number of times that CloudFront attempts to connect to the origin; |
connection | Duration | The number of seconds that CloudFront waits when trying to establish a connection to the origin. |
custom | { [string]: string } | A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. |
origin | string | An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. |
origin | 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.
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').
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.