AWS::ElasticLoadBalancingV2::ListenerRule RuleCondition

Specifies a condition for a listener rule.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Field" : String,
  "HostHeaderConfig" : HostHeaderConfig,
  "HttpHeaderConfig" : HttpHeaderConfig,
  "HttpRequestMethodConfig" : HttpRequestMethodConfig,
  "PathPatternConfig" : PathPatternConfig,
  "QueryStringConfig" : QueryStringConfig,
  "SourceIpConfig" : SourceIpConfig,
  "Values" : [ String, ... ]
}

YAML

  Field: String
  HostHeaderConfig: 
    HostHeaderConfig
  HttpHeaderConfig: 
    HttpHeaderConfig
  HttpRequestMethodConfig: 
    HttpRequestMethodConfig
  PathPatternConfig: 
    PathPatternConfig
  QueryStringConfig: 
    QueryStringConfig
  SourceIpConfig: 
    SourceIpConfig
  Values: 
    - String

Properties

Field

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

Required: No

Type: String

Maximum: 64

Update requires: No interruption

HostHeaderConfig

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

Required: No

Type: HostHeaderConfig

Update requires: No interruption

HttpHeaderConfig

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

Required: Conditional

Type: HttpHeaderConfig

Update requires: No interruption

HttpRequestMethodConfig

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

Required: Conditional

Type: HttpRequestMethodConfig

Update requires: No interruption

PathPatternConfig

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

Required: No

Type: PathPatternConfig

Update requires: No interruption

QueryStringConfig

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

Required: Conditional

Type: QueryStringConfig

Update requires: No interruption

SourceIpConfig

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

Required: Conditional

Type: SourceIpConfig

Update requires: No interruption

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're not using HostHeaderConfig, 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 and you're not using PathPatternConfig, 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 &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

Required: No

Type: Array of String

Update requires: No interruption