# CustomOriginConfig

A custom origin configuration.

- Source: [`aws-cloudfront/lib/web-distribution.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-cloudfront/lib/web-distribution.ts#L235)

## Example

TypeScript:

```ts
declare const sourceBucket: s3.Bucket;
declare const oai: cloudfront.OriginAccessIdentity;

new cloudfront.CloudFrontWebDistribution(this, 'MyCfWebDistribution', {
  originConfigs: [
    {
      s3OriginSource: {
        s3BucketSource: sourceBucket,
        originAccessIdentity: oai,
      },
      behaviors: [ {isDefaultBehavior: true}],
    },
    {
      customOriginSource: {
        domainName: 'MYALIAS',
      },
      behaviors: [{ pathPattern: '/somewhere' }]
    }
  ],
});
```

Python:

```python
# source_bucket: s3.Bucket
# oai: cloudfront.OriginAccessIdentity

cloudfront.CloudFrontWebDistribution(self, "MyCfWebDistribution",
    origin_configs=[cloudfront.SourceConfiguration(
        s3_origin_source=cloudfront.S3OriginConfig(
            s3_bucket_source=source_bucket,
            origin_access_identity=oai
        ),
        behaviors=[cloudfront.Behavior(is_default_behavior=True)]
    ), cloudfront.SourceConfiguration(
        custom_origin_source=cloudfront.CustomOriginConfig(
            domain_name="MYALIAS"
        ),
        behaviors=[cloudfront.Behavior(path_pattern="/somewhere")]
    )
    ]
)
```

Java:

```java
Bucket sourceBucket;
OriginAccessIdentity oai;

CloudFrontWebDistribution.Builder.create(this, "MyCfWebDistribution")
        .originConfigs(List.of(SourceConfiguration.builder()
                .s3OriginSource(S3OriginConfig.builder()
                        .s3BucketSource(sourceBucket)
                        .originAccessIdentity(oai)
                        .build())
                .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                .build(), SourceConfiguration.builder()
                .customOriginSource(CustomOriginConfig.builder()
                        .domainName("MYALIAS")
                        .build())
                .behaviors(List.of(Behavior.builder().pathPattern("/somewhere").build()))
                .build()))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
Bucket sourceBucket;
OriginAccessIdentity oai;

new CloudFrontWebDistribution(this, "MyCfWebDistribution", new CloudFrontWebDistributionProps {
    OriginConfigs = new [] { new SourceConfiguration {
        S3OriginSource = new S3OriginConfig {
            S3BucketSource = sourceBucket,
            OriginAccessIdentity = oai
        },
        Behaviors = new [] { new Behavior { IsDefaultBehavior = true } }
    }, new SourceConfiguration {
        CustomOriginSource = new CustomOriginConfig {
            DomainName = "MYALIAS"
        },
        Behaviors = new [] { new Behavior { PathPattern = "/somewhere" } }
    } }
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var sourceBucket Bucket
var oai OriginAccessIdentity

cloudfront.NewCloudFrontWebDistribution(this, jsii.String("MyCfWebDistribution"), &CloudFrontWebDistributionProps{
	OriginConfigs: []SourceConfiguration{
		&SourceConfiguration{
			S3OriginSource: &S3OriginConfig{
				S3BucketSource: sourceBucket,
				OriginAccessIdentity: oai,
			},
			Behaviors: []Behavior{
				&Behavior{
					IsDefaultBehavior: jsii.Boolean(true),
				},
			},
		},
		&SourceConfiguration{
			CustomOriginSource: &CustomOriginConfig{
				DomainName: jsii.String("MYALIAS"),
			},
			Behaviors: []Behavior{
				&Behavior{
					PathPattern: jsii.String("/somewhere"),
				},
			},
		},
	},
})
```

## Properties

- `allowedOriginSSLVersions`: [OriginSslPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront.OriginSslPolicy.html)[] = OriginSslPolicy.TLS_V1_2 — The SSL versions to use when interacting with the origin.

- `domainName`: string (required) — The domain name of the custom origin.

  Should not include the path - that should be in the parent SourceConfiguration

- `httpPort`: number = 80 — The origin HTTP port.

- `httpsPort`: number = 443 — The origin HTTPS port.

- `originHeaders`: { [key: string]: string } — Any additional headers to pass to the origin.

  **Default:** No additional headers are passed.

- `originKeepaliveTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.seconds(5) — The keep alive timeout when making calls in seconds.

- `originPath`: string = / — The relative path to the origin root to use for sources.

- `originProtocolPolicy`: [OriginProtocolPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront.OriginProtocolPolicy.html) = OriginProtocolPolicy.HttpsOnly — The protocol (http or https) policy to use when interacting with the origin.

- `originReadTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.seconds(30) — The read timeout when calling the origin in seconds.

- `originShieldRegion`: string — 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
