Skip to content

/AWS1/CL_EL2RULECONDITION

Information about a condition for a rule.

Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string. Note that the value for a condition can't be empty.

For Network Load Balancer listener rules, the only supported condition is source-ip. Use SourceIpConfig with IpAddressType to match on the IP address type of the source traffic (ipv4 or ipv6).

For more information, see Quotas for your Application Load Balancers.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_field TYPE /AWS1/EL2CONDITIONFIELDNAME /AWS1/EL2CONDITIONFIELDNAME

The name of the field. The possible values are:

  • http-header – [ALB] Matches on an HTTP header field.

  • http-request-method – [ALB] Matches on the HTTP request method.

  • host-header – [ALB] Matches on the host header.

  • path-pattern – [ALB] Matches on the URL path of the request.

  • query-string – [ALB] Matches on a query string parameter.

  • source-ip – [ALB, NLB] Matches on the source IP address. For ALB, use SourceIpConfig with Values to specify CIDR ranges. For NLB, use SourceIpConfig with IpAddressType to match the IP address type (ipv4 or ipv6).

it_values TYPE /AWS1/CL_EL2LISTOFSTRING_W=>TT_LISTOFSTRING TT_LISTOFSTRING

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • - .

  • (matches 0 or more characters)

  • ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ " ' @ : +

  • & (using &)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

io_hostheaderconfig TYPE REF TO /AWS1/CL_EL2HOSTHEADERCONDCFG /AWS1/CL_EL2HOSTHEADERCONDCFG

Information for a host header condition. Specify only when Field is host-header.

io_pathpatternconfig TYPE REF TO /AWS1/CL_EL2PATHPATCONDCONFIG /AWS1/CL_EL2PATHPATCONDCONFIG

Information for a path pattern condition. Specify only when Field is path-pattern.

io_httpheaderconfig TYPE REF TO /AWS1/CL_EL2HTTPHEADERCONDCFG /AWS1/CL_EL2HTTPHEADERCONDCFG

Information for an HTTP header condition. Specify only when Field is http-header.

io_querystringconfig TYPE REF TO /AWS1/CL_EL2QUERYSTRINGCONDCFG /AWS1/CL_EL2QUERYSTRINGCONDCFG

Information for a query string condition. Specify only when Field is query-string.

io_httprequestmethodconfig TYPE REF TO /AWS1/CL_EL2HTTPREQMETHCONDCFG /AWS1/CL_EL2HTTPREQMETHCONDCFG

Information for an HTTP method condition. Specify only when Field is http-request-method.

io_sourceipconfig TYPE REF TO /AWS1/CL_EL2SOURCEIPCONDCONFIG /AWS1/CL_EL2SOURCEIPCONDCONFIG

Information for a source IP condition. Specify only when Field is source-ip.

it_regexvalues TYPE /AWS1/CL_EL2LISTOFSTRING_W=>TT_LISTOFSTRING TT_LISTOFSTRING

The regular expressions to match against the condition field. The maximum length of each string is 128 characters. Specify only when Field is http-header, host-header, or path-pattern.

Queryable Attributes

Field

The name of the field. The possible values are:

  • http-header – [ALB] Matches on an HTTP header field.

  • http-request-method – [ALB] Matches on the HTTP request method.

  • host-header – [ALB] Matches on the host header.

  • path-pattern – [ALB] Matches on the URL path of the request.

  • query-string – [ALB] Matches on a query string parameter.

  • source-ip – [ALB, NLB] Matches on the source IP address. For ALB, use SourceIpConfig with Values to specify CIDR ranges. For NLB, use SourceIpConfig with IpAddressType to match the IP address type (ipv4 or ipv6).

Accessible with the following methods

Method Description
GET_FIELD() Getter for FIELD, with configurable default
ASK_FIELD() Getter for FIELD w/ exceptions if field has no value
HAS_FIELD() Determine if FIELD has a value

Values

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • - .

  • (matches 0 or more characters)

  • ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ " ' @ : +

  • & (using &)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

Accessible with the following methods

Method Description
GET_VALUES() Getter for VALUES, with configurable default
ASK_VALUES() Getter for VALUES w/ exceptions if field has no value
HAS_VALUES() Determine if VALUES has a value

HostHeaderConfig

Information for a host header condition. Specify only when Field is host-header.

Accessible with the following methods

Method Description
GET_HOSTHEADERCONFIG() Getter for HOSTHEADERCONFIG

PathPatternConfig

Information for a path pattern condition. Specify only when Field is path-pattern.

Accessible with the following methods

Method Description
GET_PATHPATTERNCONFIG() Getter for PATHPATTERNCONFIG

HttpHeaderConfig

Information for an HTTP header condition. Specify only when Field is http-header.

Accessible with the following methods

Method Description
GET_HTTPHEADERCONFIG() Getter for HTTPHEADERCONFIG

QueryStringConfig

Information for a query string condition. Specify only when Field is query-string.

Accessible with the following methods

Method Description
GET_QUERYSTRINGCONFIG() Getter for QUERYSTRINGCONFIG

HttpRequestMethodConfig

Information for an HTTP method condition. Specify only when Field is http-request-method.

Accessible with the following methods

Method Description
GET_HTTPREQUESTMETHODCONFIG() Getter for HTTPREQUESTMETHODCONFIG

SourceIpConfig

Information for a source IP condition. Specify only when Field is source-ip.

Accessible with the following methods

Method Description
GET_SOURCEIPCONFIG() Getter for SOURCEIPCONFIG

RegexValues

The regular expressions to match against the condition field. The maximum length of each string is 128 characters. Specify only when Field is http-header, host-header, or path-pattern.

Accessible with the following methods

Method Description
GET_REGEXVALUES() Getter for REGEXVALUES, with configurable default
ASK_REGEXVALUES() Getter for REGEXVALUES w/ exceptions if field has no value
HAS_REGEXVALUES() Determine if REGEXVALUES has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_RULECONDITIONLIST

TYPES TT_RULECONDITIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EL2RULECONDITION WITH DEFAULT KEY
.