You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::RuleCondition

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RuleCondition as input to an Aws::Client method, you can use a vanilla Hash:

{
  field: "ConditionFieldName",
  values: ["StringValue"],
  host_header_config: {
    values: ["StringValue"],
  },
  path_pattern_config: {
    values: ["StringValue"],
  },
  http_header_config: {
    http_header_name: "HttpHeaderConditionName",
    values: ["StringValue"],
  },
  query_string_config: {
    values: [
      {
        key: "StringValue",
        value: "StringValue",
      },
    ],
  },
  http_request_method_config: {
    values: ["StringValue"],
  },
  source_ip_config: {
    values: ["StringValue"],
  },
}

Information about a condition for a rule.

Instance Attribute Summary collapse

Instance Attribute Details

#fieldString

The field in the HTTP request. The following are the possible values:

  • http-header

  • http-request-method

  • host-header

  • path-pattern

  • query-string

  • source-ip

Returns:

  • (String)

    The field in the HTTP request.

#host_header_configTypes::HostHeaderConditionConfig

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

Returns:

#http_header_configTypes::HttpHeaderConditionConfig

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

Returns:

#http_request_method_configTypes::HttpRequestMethodConditionConfig

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

Returns:

#path_pattern_configTypes::PathPatternConditionConfig

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

Returns:

#query_string_configTypes::QueryStringConditionConfig

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

Returns:

#source_ip_configTypes::SourceIpConditionConfig

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

Returns:

#valuesArray<String>

The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions.

If Field is host-header, you can specify a single host name (for example, my.example.com). 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, you can specify a single path pattern (for example, /img/*). 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 &amp;)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

Returns:

  • (Array<String>)

    The condition value.