software.amazon.awscdk.services.cloudfront

Interface OriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:48.826Z")
 @Stability(value=Stable)
public interface OriginProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.core.*;
 OriginProps originProps = OriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .originPath("originPath")
         .originShieldRegion("originShieldRegion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OriginProps.Builder A builder for OriginProps
static class	OriginProps.Jsii$Proxy An implementation for OriginProps

Method Summary

Modifier and Type	Method and Description
static OriginProps.Builder	builder()
default Number	getConnectionAttempts() The number of times that CloudFront attempts to connect to the origin;
default Duration	getConnectionTimeout() The number of seconds that CloudFront waits when trying to establish a connection to the origin.
default Map<String,String>	getCustomHeaders() A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
default String	getOriginPath() An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
default String	getOriginShieldRegion() When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConnectionAttempts

@Stability(value=Stable)
 @Nullable
default Number getConnectionAttempts()

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

valid values are 1, 2, or 3 attempts.

Default: 3

getConnectionTimeout

@Stability(value=Stable)
 @Nullable
default Duration getConnectionTimeout()

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

Valid values are 1-10 seconds, inclusive.

Default: Duration.seconds(10)

getCustomHeaders

@Stability(value=Stable)
 @Nullable
default Map<String,String> getCustomHeaders()

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

Default: {}

getOriginPath

@Stability(value=Stable)
 @Nullable
default String getOriginPath()

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').

Default: '/'

getOriginShieldRegion

@Stability(value=Stable)
 @Nullable
default String getOriginShieldRegion()

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

Default: - origin shield not enabled

See Also:

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

builder

@Stability(value=Stable)
static OriginProps.Builder builder()

Returns:

a OriginProps.Builder of OriginProps