aws-cdk-lib.aws_cloudfront.CfnDistribution.OriginProperty

OriginProperty Struct

An origin.

An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:

• Use S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.

• Use VpcOriginConfig to specify a VPC origin.

• Use CustomOriginConfig to specify all other kinds of origins, including:

• An Amazon S3 bucket that is configured with static website hosting

• An Elastic Load Balancing load balancer

• An AWS Elemental MediaPackage endpoint

• An AWS Elemental MediaStore container

• Any other HTTP server, running on an Amazon EC2 instance or any other kind of host

For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).

Source

Generated code

Type last changed

v2.203.0 · 1 Jul 2025

Example

// 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 originProperty: cloudfront.CfnDistribution.OriginProperty = {
  domainName: 'domainName',
  id: 'id',

  // the properties below are optional
  connectionAttempts: 123,
  connectionTimeout: 123,
  customOriginConfig: {
    originProtocolPolicy: 'originProtocolPolicy',

    // the properties below are optional
    httpPort: 123,
    httpsPort: 123,
    ipAddressType: 'ipAddressType',
    originKeepaliveTimeout: 123,
    originMtlsConfig: {
      clientCertificateArn: 'clientCertificateArn',
    },
    originReadTimeout: 123,
    originSslProtocols: ['originSslProtocols'],
  },
  originAccessControlId: 'originAccessControlId',
  originCustomHeaders: [{
    headerName: 'headerName',
    headerValue: 'headerValue',
  }],
  originPath: 'originPath',
  originShield: {
    enabled: false,
    originShieldRegion: 'originShieldRegion',
  },
  responseCompletionTimeout: 123,
  s3OriginConfig: {
    originAccessIdentity: 'originAccessIdentity',
    originReadTimeout: 123,
  },
  vpcOriginConfig: {
    vpcOriginId: 'vpcOriginId',

    // the properties below are optional
    originKeepaliveTimeout: 123,
    originReadTimeout: 123,
    ownerAccountId: 'ownerAccountId',
  },
};

Properties

connectionAttempts?optionalnumberconnection_attempts?optionalint | floatconnectionAttempts?optionalNumberConnectionAttempts?optionaldoubleConnectionAttempts?optional*float64#

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

notes

The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .

connectionTimeout?optionalnumberconnection_timeout?optionalint | floatconnectionTimeout?optionalNumberConnectionTimeout?optionaldoubleConnectionTimeout?optional*float64#

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

notes

The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .

customOriginConfig?optionalIResolvable | CfnDistribution.CustomOriginConfigPropertycustom_origin_config?optionaltyping.Union[IResolvable, CustomOriginConfigProperty]customOriginConfig?optionalIResolvableCustomOriginConfig?optionalIResolvableCustomOriginConfig?optionalinterface{}#

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.

If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .

idstringidstridStringIdstringId*stringrequired#

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .

originAccessControlId?optionalstringorigin_access_control_id?optionalstroriginAccessControlId?optionalStringOriginAccessControlId?optionalstringOriginAccessControlId?optional*string#

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

For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .

originCustomHeaders?optionalIResolvable | IResolvable | CfnDistribution.OriginCustomHeaderProperty[]origin_custom_headers?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OriginCustomHeaderProperty]]]originCustomHeaders?optionalIResolvableOriginCustomHeaders?optionalIResolvableOriginCustomHeaders?optionalinterface{}#

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

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .

originPath?optionalstringorigin_path?optionalstroriginPath?optionalStringOriginPath?optionalstringOriginPath?optional*string= ""#

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

For more information, see Origin Path in the Amazon CloudFront Developer Guide .

originShield?optionalIResolvable | CfnDistribution.OriginShieldPropertyorigin_shield?optionaltyping.Union[IResolvable, OriginShieldProperty]originShield?optionalIResolvableOriginShield?optionalIResolvableOriginShield?optionalinterface{}#

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide .

responseCompletionTimeout?optionalnumberresponse_completion_timeout?optionalint | floatresponseCompletionTimeout?optionalNumberResponseCompletionTimeout?optionaldoubleResponseCompletionTimeout?optional*float64#

The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response.

notes

If the complete response isn't received from the origin by this time, CloudFront ends the connection.

The value for ResponseCompletionTimeout must be equal to or greater than the value for OriginReadTimeout . If you don't set a value for ResponseCompletionTimeout , CloudFront doesn't enforce a maximum value.

For more information, see Response completion timeout in the Amazon CloudFront Developer Guide .

s3OriginConfig?optionalIResolvable | CfnDistribution.S3OriginConfigPropertys3_origin_config?optionaltyping.Union[IResolvable, S3OriginConfigProperty]s3OriginConfig?optionalIResolvableS3OriginConfig?optionalIResolvableS3OriginConfig?optionalinterface{}#

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.

To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

vpcOriginConfig?optionalIResolvable | CfnDistribution.VpcOriginConfigPropertyvpc_origin_config?optionaltyping.Union[IResolvable, VpcOriginConfigProperty]vpcOriginConfig?optionalIResolvableVpcOriginConfig?optionalIResolvableVpcOriginConfig?optionalinterface{}#

The VPC origin configuration.