software.amazon.awscdk.services.cloudfront

Interface OriginOptions

All Known Subinterfaces:

HttpOriginProps, LoadBalancerV2OriginProps, OriginProps, RestApiOriginProps, S3OriginProps

All Known Implementing Classes:

HttpOriginProps.Jsii$Proxy, LoadBalancerV2OriginProps.Jsii$Proxy, OriginOptions.Jsii$Proxy, OriginProps.Jsii$Proxy, RestApiOriginProps.Jsii$Proxy, S3OriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.118Z")
public interface 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 software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.core.*;
 OriginOptions originOptions = OriginOptions.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .originShieldRegion("originShieldRegion")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static OriginOptions.Builder	builder()
default java.lang.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 java.util.Map<java.lang.String,java.lang.String>	getCustomHeaders() A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
default java.lang.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.

Method Detail

getConnectionAttempts

default java.lang.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

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

default java.util.Map<java.lang.String,java.lang.String> getCustomHeaders()

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

Default: {}

getOriginShieldRegion

default java.lang.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

static OriginOptions.Builder builder()

Returns:

a OriginOptions.Builder of OriginOptions