interface OriginOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudFront.OriginOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#OriginOptions |
![]() | software.amazon.awscdk.services.cloudfront.OriginOptions |
![]() | aws_cdk.aws_cloudfront.OriginOptions |
![]() | aws-cdk-lib » aws_cloudfront » OriginOptions |
Options 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 originOptions: cloudfront.OriginOptions = {
connectionAttempts: 123,
connectionTimeout: cdk.Duration.minutes(30),
customHeaders: {
customHeadersKey: 'customHeaders',
},
originAccessControlId: 'originAccessControlId',
originId: 'originId',
originShieldEnabled: false,
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 | The unique identifier of an origin access control for this origin. |
origin | string | A unique identifier for the origin. |
origin | 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. |
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.
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.
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.