aws-cdk-lib.aws_elasticloadbalancingv2.CfnListenerRule.HttpHeaderConfigProperty

HttpHeaderConfigProperty Struct

Information about an HTTP header condition.

There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

Source

Generated code

Type last changed

v2.221.0 · 24 Oct 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
const httpHeaderConfigProperty: elbv2.CfnListenerRule.HttpHeaderConfigProperty = {
  httpHeaderName: 'httpHeaderName',
  regexValues: ['regexValues'],
  values: ['values'],
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticloadbalancingv2 as elbv2

http_header_config_property = elbv2.CfnListenerRule.HttpHeaderConfigProperty(
    http_header_name="httpHeaderName",
    regex_values=["regexValues"],
    values=["values"]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticloadbalancingv2.*;

HttpHeaderConfigProperty httpHeaderConfigProperty = HttpHeaderConfigProperty.builder()
        .httpHeaderName("httpHeaderName")
        .regexValues(List.of("regexValues"))
        .values(List.of("values"))
        .build();

// 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.ElasticLoadBalancingV2;

var httpHeaderConfigProperty = new HttpHeaderConfigProperty {
    HttpHeaderName = "httpHeaderName",
    RegexValues = new [] { "regexValues" },
    Values = new [] { "values" }
};

// 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"

httpHeaderConfigProperty := &HttpHeaderConfigProperty{
	HttpHeaderName: jsii.String("httpHeaderName"),
	RegexValues: []*string{
		jsii.String("regexValues"),
	},
	Values: []*string{
		jsii.String("values"),
	},
}

Properties

httpHeaderName?optionalstringhttp_header_name?optionalstrhttpHeaderName?optionalStringHttpHeaderName?optionalstringHttpHeaderName?optional*string#

The name of the HTTP header field.

The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.

regexValues?optionalstring[]regex_values?optionaltyping.List[str]regexValues?optionalList<String>RegexValues?optionalstring[]RegexValues?optional*[]*string#

values?optionalstring[]values?optionaltyping.List[str]values?optionalList<String>Values?optionalstring[]Values?optional*[]*string#

The strings to compare against the value of the HTTP header.

notes

The maximum length of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If the same header appears multiple times in the request, we search them in order until a match is found.

If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.