1.204.0

interface HttpOriginProps

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.Origins.HttpOriginProps
Javasoftware.amazon.awscdk.services.cloudfront.origins.HttpOriginProps
Pythonaws_cdk.aws_cloudfront_origins.HttpOriginProps
TypeScript (source)@aws-cdk/aws-cloudfront-origins » HttpOriginProps

Properties for an Origin backed by an S3 website-configured bucket, load balancer, or custom HTTP server.

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 cloudfront_origins from '@aws-cdk/aws-cloudfront-origins';
import * as cdk from '@aws-cdk/core';
const httpOriginProps: cloudfront_origins.HttpOriginProps = {
  connectionAttempts: 123,
  connectionTimeout: cdk.Duration.minutes(30),
  customHeaders: {
    customHeadersKey: 'customHeaders',
  },
  httpPort: 123,
  httpsPort: 123,
  keepaliveTimeout: cdk.Duration.minutes(30),
  originPath: 'originPath',
  originShieldRegion: 'originShieldRegion',
  originSslProtocols: [cloudfront.OriginSslPolicy.SSL_V3],
  protocolPolicy: cloudfront.OriginProtocolPolicy.HTTP_ONLY,
  readTimeout: cdk.Duration.minutes(30),
};

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.
httpPort?numberThe HTTP port that CloudFront uses to connect to the origin.
httpsPort?numberThe HTTPS port that CloudFront uses to connect to the origin.
keepaliveTimeout?DurationSpecifies how long, in seconds, CloudFront persists its connection to the origin.
originPath?stringAn optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
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[]The SSL versions to use when interacting with the origin.
protocolPolicy?OriginProtocolPolicySpecifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
readTimeout?DurationSpecifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

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.

httpPort?

Type: number (optional, default: 80)

The HTTP port that CloudFront uses to connect to the origin.

httpsPort?

Type: number (optional, default: 443)

The HTTPS port that CloudFront uses to connect to the origin.

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.

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.

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

originSslProtocols?

Type: OriginSslPolicy[] (optional, default: OriginSslPolicy.TLS_V1_2)

The SSL versions to use when interacting with the origin.

protocolPolicy?

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

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

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.

← PreviousNext →