RuleCondition ¶

class RuleCondition(TypedDict, closed=True):
    field: NotRequired[
        "capo_elastic_load_balancing_v2.types.condition_field_name.ConditionFieldName"
    ]
    """<p>The name of the field. The possible values are:</p> <ul> <li> <p> <code>http-header</code> – [ALB] Matches on an HTTP header field.</p> </li> <li> <p> <code>http-request-method</code> – [ALB] Matches on the HTTP request method.</p> </li> <li> <p> <code>host-header</code> – [ALB] Matches on the host header.</p> </li> <li> <p> <code>path-pattern</code> – [ALB] Matches on the URL path of the request.</p> </li> <li> <p> <code>query-string</code> – [ALB] Matches on a query string parameter.</p> </li> <li> <p> <code>source-ip</code> – [ALB, NLB] Matches on the source IP address. For ALB, use <code>SourceIpConfig</code> with <code>Values</code> to specify CIDR ranges. For NLB, use <code>SourceIpConfig</code> with <code>IpAddressType</code> to match the IP address type (<code>ipv4</code> or <code>ipv6</code>).</p> </li> </ul>"""
    values: NotRequired[
        "capo_elastic_load_balancing_v2.types.list_of_string.ListOfString"
    ]
    """<p>The condition value. Specify only when <code>Field</code> is <code>host-header</code> or <code>path-pattern</code>. Alternatively, to specify multiple host names or multiple path patterns, use <code>HostHeaderConfig</code> or <code>PathPatternConfig</code>.</p> <p>If <code>Field</code> is <code>host-header</code> and you are not using <code>HostHeaderConfig</code>, you can specify a single host name (for example, my.example.com) in <code>Values</code>. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If <code>Field</code> is <code>path-pattern</code> and you are not using <code>PathPatternConfig</code>, you can specify a single path pattern (for example, /img/*) in <code>Values</code>. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ " ' @ : +</p> </li> <li> <p>& (using &amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"""
    host_header_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.host_header_condition_config.HostHeaderConditionConfig"
    ]
    """<p>Information for a host header condition. Specify only when <code>Field</code> is <code>host-header</code>.</p>"""
    path_pattern_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.path_pattern_condition_config.PathPatternConditionConfig"
    ]
    """<p>Information for a path pattern condition. Specify only when <code>Field</code> is <code>path-pattern</code>.</p>"""
    http_header_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.http_header_condition_config.HttpHeaderConditionConfig"
    ]
    """<p>Information for an HTTP header condition. Specify only when <code>Field</code> is <code>http-header</code>.</p>"""
    query_string_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.query_string_condition_config.QueryStringConditionConfig"
    ]
    """<p>Information for a query string condition. Specify only when <code>Field</code> is <code>query-string</code>.</p>"""
    http_request_method_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.http_request_method_condition_config.HttpRequestMethodConditionConfig"
    ]
    """<p>Information for an HTTP method condition. Specify only when <code>Field</code> is <code>http-request-method</code>.</p>"""
    source_ip_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.source_ip_condition_config.SourceIpConditionConfig"
    ]
    """<p>Information for a source IP condition. Specify only when <code>Field</code> is <code>source-ip</code>.</p>"""
    regex_values: NotRequired[
        "capo_elastic_load_balancing_v2.types.list_of_string.ListOfString"
    ]
    """<p>The regular expressions to match against the condition field. The maximum length of each string is 128 characters. Specify only when <code>Field</code> is <code>http-header</code>, <code>host-header</code>, or <code>path-pattern</code>.</p>"""