Class CfnDistribution.CustomOriginConfigProperty

A custom origin.

Inheritance

object

CfnDistribution.CustomOriginConfigProperty

Implements

CfnDistribution.ICustomOriginConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDistribution.CustomOriginConfigProperty : CfnDistribution.ICustomOriginConfigProperty

Syntax (vb)

Public Class CfnDistribution.CustomOriginConfigProperty Implements CfnDistribution.ICustomOriginConfigProperty

Remarks

A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html

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.AWS.CloudFront;

             var customOriginConfigProperty = new CustomOriginConfigProperty {
                 OriginProtocolPolicy = "originProtocolPolicy",

                 // the properties below are optional
                 HttpPort = 123,
                 HttpsPort = 123,
                 IpAddressType = "ipAddressType",
                 OriginKeepaliveTimeout = 123,
                 OriginMtlsConfig = new OriginMtlsConfigProperty {
                     ClientCertificateArn = "clientCertificateArn"
                 },
                 OriginReadTimeout = 123,
                 OriginSslProtocols = new [] { "originSslProtocols" }
             };

Synopsis

Constructors

CustomOriginConfigProperty()

A custom origin.

Properties

HttpPort	The HTTP port that CloudFront uses to connect to the origin.
HttpsPort	The HTTPS port that CloudFront uses to connect to the origin.
IpAddressType	Specifies which IP protocol CloudFront uses when connecting to your origin.
OriginKeepaliveTimeout	Specifies how long, in seconds, CloudFront persists its connection to the origin.
OriginMtlsConfig	A custom origin.
OriginProtocolPolicy	Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:.
OriginReadTimeout	Specifies how long, in seconds, CloudFront waits for a response from the origin.
OriginSslProtocols	Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.

Constructors

CustomOriginConfigProperty()

A custom origin.

public CustomOriginConfigProperty()

Remarks

A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html

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.AWS.CloudFront;

             var customOriginConfigProperty = new CustomOriginConfigProperty {
                 OriginProtocolPolicy = "originProtocolPolicy",

                 // the properties below are optional
                 HttpPort = 123,
                 HttpsPort = 123,
                 IpAddressType = "ipAddressType",
                 OriginKeepaliveTimeout = 123,
                 OriginMtlsConfig = new OriginMtlsConfigProperty {
                     ClientCertificateArn = "clientCertificateArn"
                 },
                 OriginReadTimeout = 123,
                 OriginSslProtocols = new [] { "originSslProtocols" }
             };

Properties

HttpPort

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

public double? HttpPort { get; set; }

Property Value

double?

Remarks

Specify the HTTP port that the origin listens on.

Default: - 80

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport

HttpsPort

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

public double? HttpsPort { get; set; }

Property Value

double?

Remarks

Specify the HTTPS port that the origin listens on.

Default: - 443

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport

IpAddressType

Specifies which IP protocol CloudFront uses when connecting to your origin.

public string? IpAddressType { get; set; }

Property Value

string

Remarks

If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-ipaddresstype

OriginKeepaliveTimeout

Specifies how long, in seconds, CloudFront persists its connection to the origin.

public double? OriginKeepaliveTimeout { get; set; }

Property Value

double?

Remarks

The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide .

Default: - 5

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout

OriginMtlsConfig

A custom origin.

public object? OriginMtlsConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originmtlsconfig

Type union: either IResolvable or CfnDistribution.IOriginMtlsConfigProperty

OriginProtocolPolicy

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:.

public string OriginProtocolPolicy { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy

OriginReadTimeout

Specifies how long, in seconds, CloudFront waits for a response from the origin.

public double? OriginReadTimeout { get; set; }

Property Value

double?

Remarks

This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout in the Amazon CloudFront Developer Guide .

Default: - 30

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout

OriginSslProtocols

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.

public string[]? OriginSslProtocols { get; set; }

Property Value

string[]

Remarks

Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .

For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols

Implements

CfnDistribution.ICustomOriginConfigProperty