Class OriginProps
Properties to define an Origin.
Inheritance
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OriginProps : Object, IOriginProps, IOriginOptions
Syntax (vb)
Public Class OriginProps
Inherits Object
Implements IOriginProps, IOriginOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CloudFront;
var originProps = new OriginProps {
ConnectionAttempts = 123,
ConnectionTimeout = Duration.Minutes(30),
CustomHeaders = new Dictionary<string, string> {
{ "customHeadersKey", "customHeaders" }
},
OriginAccessControlId = "originAccessControlId",
OriginId = "originId",
OriginPath = "originPath",
OriginShieldEnabled = false,
OriginShieldRegion = "originShieldRegion"
};
Synopsis
Constructors
OriginProps() |
Properties
ConnectionAttempts | The number of times that CloudFront attempts to connect to the origin; |
ConnectionTimeout | The number of seconds that CloudFront waits when trying to establish a connection to the origin. |
CustomHeaders | A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. |
OriginAccessControlId | The unique identifier of an origin access control for this origin. |
OriginId | A unique identifier for the origin. |
OriginPath | An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. |
OriginShieldEnabled | Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false. |
OriginShieldRegion | When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. |
Constructors
OriginProps()
public OriginProps()
Properties
ConnectionAttempts
The number of times that CloudFront attempts to connect to the origin;
public Nullable<double> ConnectionAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
valid values are 1, 2, or 3 attempts.
Default: 3
ConnectionTimeout
The number of seconds that CloudFront waits when trying to establish a connection to the origin.
public Duration ConnectionTimeout { get; set; }
Property Value
Remarks
Valid values are 1-10 seconds, inclusive.
Default: Duration.seconds(10)
CustomHeaders
A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
public IDictionary<string, string> CustomHeaders { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: {}
OriginAccessControlId
The unique identifier of an origin access control for this origin.
public string OriginAccessControlId { get; set; }
Property Value
System.String
Remarks
Default: - no origin access control
OriginId
A unique identifier for the origin.
public string OriginId { get; set; }
Property Value
System.String
Remarks
This value must be unique within the distribution.
Default: - an originid will be generated for you
OriginPath
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
public string OriginPath { get; set; }
Property Value
System.String
Remarks
Must begin, but not end, with '/' (e.g., '/production/images').
Default: '/'
OriginShieldEnabled
Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.
public Nullable<bool> OriginShieldEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - true
OriginShieldRegion
When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
public string OriginShieldRegion { get; set; }
Property Value
System.String
Remarks
Default: - origin shield not enabled
See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html