Interface IOriginBindConfig

The struct returned from IOrigin.bind.

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IOriginBindConfig

Syntax (vb)

Public Interface IOriginBindConfig

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

            IOrigin origin;

            var originBindConfig = new OriginBindConfig {
                FailoverConfig = new OriginFailoverConfig {
                    FailoverOrigin = origin,

                    // the properties below are optional
                    StatusCodes = new [] { 123 }
                },
                OriginProperty = new OriginProperty {
                    DomainName = "domainName",
                    Id = "id",

                    // the properties below are optional
                    ConnectionAttempts = 123,
                    ConnectionTimeout = 123,
                    CustomOriginConfig = 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" }
                    },
                    OriginAccessControlId = "originAccessControlId",
                    OriginCustomHeaders = new [] { new OriginCustomHeaderProperty {
                        HeaderName = "headerName",
                        HeaderValue = "headerValue"
                    } },
                    OriginPath = "originPath",
                    OriginShield = new OriginShieldProperty {
                        Enabled = false,
                        OriginShieldRegion = "originShieldRegion"
                    },
                    ResponseCompletionTimeout = 123,
                    S3OriginConfig = new S3OriginConfigProperty {
                        OriginAccessIdentity = "originAccessIdentity",
                        OriginReadTimeout = 123
                    },
                    VpcOriginConfig = new VpcOriginConfigProperty {
                        VpcOriginId = "vpcOriginId",

                        // the properties below are optional
                        OriginKeepaliveTimeout = 123,
                        OriginReadTimeout = 123,
                        OwnerAccountId = "ownerAccountId"
                    }
                },
                SelectionCriteria = OriginSelectionCriteria.DEFAULT
            };

Synopsis

Properties

FailoverConfig	The failover configuration for this Origin.
OriginProperty	The CloudFormation OriginProperty configuration for this Origin.
SelectionCriteria	The selection criteria for how your origins are selected.

Properties

FailoverConfig

The failover configuration for this Origin.

IOriginFailoverConfig? FailoverConfig { get; }

Property Value

IOriginFailoverConfig

Remarks

Default: - nothing is returned

OriginProperty

The CloudFormation OriginProperty configuration for this Origin.

CfnDistribution.IOriginProperty? OriginProperty { get; }

Property Value

CfnDistribution.IOriginProperty

Remarks

Default: - nothing is returned

SelectionCriteria

The selection criteria for how your origins are selected.

OriginSelectionCriteria? SelectionCriteria { get; }

Property Value

OriginSelectionCriteria?

Remarks

Default: - OriginSelectionCriteria.DEFAULT

See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating