awscloudfrontorigins

Documentation

Index

• func NewHttpOrigin_Override(h HttpOrigin, domainName *string, props *HttpOriginProps)
• func NewLoadBalancerV2Origin_Override(l LoadBalancerV2Origin, loadBalancer awselasticloadbalancingv2.ILoadBalancerV2, ...)
• func NewOriginGroup_Override(o OriginGroup, props *OriginGroupProps)
• func NewS3Origin_Override(s S3Origin, bucket awss3.IBucket, props *S3OriginProps)
• type HttpOrigin
  • func NewHttpOrigin(domainName *string, props *HttpOriginProps) HttpOrigin
• type HttpOriginProps
• type LoadBalancerV2Origin
  • func NewLoadBalancerV2Origin(loadBalancer awselasticloadbalancingv2.ILoadBalancerV2, ...) LoadBalancerV2Origin
• type LoadBalancerV2OriginProps
• type OriginGroup
  • func NewOriginGroup(props *OriginGroupProps) OriginGroup
• type OriginGroupProps
• type S3Origin
  • func NewS3Origin(bucket awss3.IBucket, props *S3OriginProps) S3Origin
• type S3OriginProps

Functions

func NewHttpOrigin_Override

func NewHttpOrigin_Override(h HttpOrigin, domainName *string, props *HttpOriginProps)

Experimental.

func NewLoadBalancerV2Origin_Override

func NewLoadBalancerV2Origin_Override(l LoadBalancerV2Origin, loadBalancer awselasticloadbalancingv2.ILoadBalancerV2, props *LoadBalancerV2OriginProps)

Experimental.

func NewOriginGroup_Override

func NewOriginGroup_Override(o OriginGroup, props *OriginGroupProps)

Experimental.

func NewS3Origin_Override

func NewS3Origin_Override(s S3Origin, bucket awss3.IBucket, props *S3OriginProps)

Experimental.

Types

type HttpOrigin

type HttpOrigin interface {
	awscloudfront.OriginBase
	Bind(_scope awscdk.Construct, options *awscloudfront.OriginBindOptions) *awscloudfront.OriginBindConfig
	RenderCustomOriginConfig() *awscloudfront.CfnDistribution_CustomOriginConfigProperty
	RenderS3OriginConfig() *awscloudfront.CfnDistribution_S3OriginConfigProperty
}

An Origin for an HTTP server or S3 bucket configured for website hosting. Experimental.

func NewHttpOrigin

func NewHttpOrigin(domainName *string, props *HttpOriginProps) HttpOrigin

Experimental.

type HttpOriginProps

type HttpOriginProps struct {
	// The number of times that CloudFront attempts to connect to the origin;
	//
	// valid values are 1, 2, or 3 attempts.
	// Experimental.
	ConnectionAttempts *float64 `json:"connectionAttempts"`
	// The number of seconds that CloudFront waits when trying to establish a connection to the origin.
	//
	// Valid values are 1-10 seconds, inclusive.
	// Experimental.
	ConnectionTimeout awscdk.Duration `json:"connectionTimeout"`
	// A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
	// Experimental.
	CustomHeaders *map[string]*string `json:"customHeaders"`
	// 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').
	// Experimental.
	OriginPath *string `json:"originPath"`
	// When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
	// See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html
	//
	// Experimental.
	OriginShieldRegion *string `json:"originShieldRegion"`
	// The HTTP port that CloudFront uses to connect to the origin.
	// Experimental.
	HttpPort *float64 `json:"httpPort"`
	// The HTTPS port that CloudFront uses to connect to the origin.
	// Experimental.
	HttpsPort *float64 `json:"httpsPort"`
	// Specifies how long, in seconds, CloudFront persists its connection to the origin.
	//
	// The valid range is from 1 to 60 seconds, inclusive.
	// Experimental.
	KeepaliveTimeout awscdk.Duration `json:"keepaliveTimeout"`
	// The SSL versions to use when interacting with the origin.
	// Experimental.
	OriginSslProtocols *[]awscloudfront.OriginSslPolicy `json:"originSslProtocols"`
	// Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
	// Experimental.
	ProtocolPolicy awscloudfront.OriginProtocolPolicy `json:"protocolPolicy"`
	// 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 60 seconds, inclusive.
	// Experimental.
	ReadTimeout awscdk.Duration `json:"readTimeout"`
}

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

type LoadBalancerV2Origin

type LoadBalancerV2Origin interface {
	HttpOrigin
	Bind(_scope awscdk.Construct, options *awscloudfront.OriginBindOptions) *awscloudfront.OriginBindConfig
	RenderCustomOriginConfig() *awscloudfront.CfnDistribution_CustomOriginConfigProperty
	RenderS3OriginConfig() *awscloudfront.CfnDistribution_S3OriginConfigProperty
}

An Origin for a v2 load balancer. Experimental.

func NewLoadBalancerV2Origin

func NewLoadBalancerV2Origin(loadBalancer awselasticloadbalancingv2.ILoadBalancerV2, props *LoadBalancerV2OriginProps) LoadBalancerV2Origin

Experimental.

type LoadBalancerV2OriginProps

type LoadBalancerV2OriginProps struct {
	// The number of times that CloudFront attempts to connect to the origin;
	//
	// valid values are 1, 2, or 3 attempts.
	// Experimental.
	ConnectionAttempts *float64 `json:"connectionAttempts"`
	// The number of seconds that CloudFront waits when trying to establish a connection to the origin.
	//
	// Valid values are 1-10 seconds, inclusive.
	// Experimental.
	ConnectionTimeout awscdk.Duration `json:"connectionTimeout"`
	// A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
	// Experimental.
	CustomHeaders *map[string]*string `json:"customHeaders"`
	// 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').
	// Experimental.
	OriginPath *string `json:"originPath"`
	// When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
	// See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html
	//
	// Experimental.
	OriginShieldRegion *string `json:"originShieldRegion"`
	// The HTTP port that CloudFront uses to connect to the origin.
	// Experimental.
	HttpPort *float64 `json:"httpPort"`
	// The HTTPS port that CloudFront uses to connect to the origin.
	// Experimental.
	HttpsPort *float64 `json:"httpsPort"`
	// Specifies how long, in seconds, CloudFront persists its connection to the origin.
	//
	// The valid range is from 1 to 60 seconds, inclusive.
	// Experimental.
	KeepaliveTimeout awscdk.Duration `json:"keepaliveTimeout"`
	// The SSL versions to use when interacting with the origin.
	// Experimental.
	OriginSslProtocols *[]awscloudfront.OriginSslPolicy `json:"originSslProtocols"`
	// Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
	// Experimental.
	ProtocolPolicy awscloudfront.OriginProtocolPolicy `json:"protocolPolicy"`
	// 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 60 seconds, inclusive.
	// Experimental.
	ReadTimeout awscdk.Duration `json:"readTimeout"`
}

Properties for an Origin backed by a v2 load balancer. Experimental.

type OriginGroup

type OriginGroup interface {
	awscloudfront.IOrigin
	Bind(scope awscdk.Construct, options *awscloudfront.OriginBindOptions) *awscloudfront.OriginBindConfig
}

An Origin that represents a group.

Consists of a primary Origin, and a fallback Origin called when the primary returns one of the provided HTTP status codes. Experimental.

func NewOriginGroup

func NewOriginGroup(props *OriginGroupProps) OriginGroup

Experimental.

type OriginGroupProps

type OriginGroupProps struct {
	// The fallback origin that should serve requests when the primary fails.
	// Experimental.
	FallbackOrigin awscloudfront.IOrigin `json:"fallbackOrigin"`
	// The primary origin that should serve requests for this group.
	// Experimental.
	PrimaryOrigin awscloudfront.IOrigin `json:"primaryOrigin"`
	// The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.
	// Experimental.
	FallbackStatusCodes *[]*float64 `json:"fallbackStatusCodes"`
}

Construction properties for {@link OriginGroup}. Experimental.

type S3Origin

type S3Origin interface {
	awscloudfront.IOrigin
	Bind(scope awscdk.Construct, options *awscloudfront.OriginBindOptions) *awscloudfront.OriginBindConfig
}

An Origin that is backed by an S3 bucket.

If the bucket is configured for website hosting, this origin will be configured to use the bucket as an HTTP server origin and will use the bucket's configured website redirects and error handling. Otherwise, the origin is created as a bucket origin and will use CloudFront's redirect and error handling. Experimental.

func NewS3Origin

func NewS3Origin(bucket awss3.IBucket, props *S3OriginProps) S3Origin

Experimental.

type S3OriginProps

type S3OriginProps struct {
	// An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.
	// Experimental.
	OriginAccessIdentity awscloudfront.IOriginAccessIdentity `json:"originAccessIdentity"`
	// 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').
	// Experimental.
	OriginPath *string `json:"originPath"`
}

Properties to use to customize an S3 Origin. Experimental.