Skip to content
v2.277.0

OriginCustomHeaderProperty Struct ​

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const originCustomHeaderProperty: cloudfront.CfnDistribution.OriginCustomHeaderProperty = {
  headerName: 'headerName',
  headerValue: 'headerValue',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

origin_custom_header_property = cloudfront.CfnDistribution.OriginCustomHeaderProperty(
    header_name="headerName",
    header_value="headerValue"
)
java
// 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.*;

OriginCustomHeaderProperty originCustomHeaderProperty = OriginCustomHeaderProperty.builder()
        .headerName("headerName")
        .headerValue("headerValue")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 originCustomHeaderProperty = new OriginCustomHeaderProperty {
    HeaderName = "headerName",
    HeaderValue = "headerValue"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

originCustomHeaderProperty := &OriginCustomHeaderProperty{
	HeaderName: jsii.String("headerName"),
	HeaderValue: jsii.String("headerValue"),
}

Properties ​

headerNamestringheader_namestrheaderNameStringHeaderNamestringHeaderName*stringrequired#
The name of a header that you want CloudFront to send to your origin.

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .

headerValuestringheader_valuestrheaderValueStringHeaderValuestringHeaderValue*stringrequired#
The value for the header that you specified in the `HeaderName` field.