Skip to content

Rule

Source code in docs_src/capo_elastic_load_balancing_v2/types/rule.py
class Rule(TypedDict, closed=True):
    rule_arn: NotRequired["capo_elastic_load_balancing_v2.types.rule_arn.RuleArn"]
    """<p>The Amazon Resource Name (ARN) of the rule.</p>"""
    priority: NotRequired["capo_elastic_load_balancing_v2.types.string.String"]
    """<p>The priority.</p>"""
    conditions: NotRequired[
        "capo_elastic_load_balancing_v2.types.rule_condition_list.RuleConditionList"
    ]
    """<p>The conditions. Each rule can include zero or one of the following conditions: <code>http-request-method</code>, <code>host-header</code>, <code>path-pattern</code>, and <code>source-ip</code>, and zero or more of the following conditions: <code>http-header</code> and <code>query-string</code>.</p>"""
    actions: NotRequired["capo_elastic_load_balancing_v2.types.actions.Actions"]
    """<p>The actions. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>redirect</code>, or <code>fixed-response</code>, and it must be the last action to be performed.</p>"""
    is_default: NotRequired["capo_elastic_load_balancing_v2.types.is_default.IsDefault"]
    """<p>Indicates whether this is the default rule.</p>"""
    transforms: NotRequired[
        "capo_elastic_load_balancing_v2.types.rule_transform_list.RuleTransformList"
    ]
    """<p>The transforms for the rule.</p>"""

actions instance-attribute

actions: NotRequired[Actions]

The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.

conditions instance-attribute

conditions: NotRequired[RuleConditionList]

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

is_default instance-attribute

is_default: NotRequired[IsDefault]

Indicates whether this is the default rule.

priority instance-attribute

priority: NotRequired[String]

The priority.

rule_arn instance-attribute

rule_arn: NotRequired[RuleArn]

The Amazon Resource Name (ARN) of the rule.

transforms instance-attribute

transforms: NotRequired[RuleTransformList]

The transforms for the rule.