BaseApplicationListenerRuleProps¶
-
class
aws_cdk.aws_elasticloadbalancingv2.
BaseApplicationListenerRuleProps
(*, priority, action=None, conditions=None, fixed_response=None, host_header=None, path_pattern=None, path_patterns=None, redirect_response=None, target_groups=None)¶ Bases:
object
Basic properties for defining a rule on a listener.
- Parameters
priority (
Union
[int
,float
]) – Priority of the rule. The rule with the lowest priority will be used for every request. Priorities must be unique.action (
Optional
[ListenerAction
]) – Action to perform when requests are received. Only one ofaction
,fixedResponse
,redirectResponse
ortargetGroups
can be specified. Default: - No actionconditions (
Optional
[Sequence
[ListenerCondition
]]) – Rule applies if matches the conditions. Default: - No conditions.fixed_response (
Union
[FixedResponse
,Dict
[str
,Any
],None
]) – (deprecated) Fixed response to return. Only one ofaction
,fixedResponse
,redirectResponse
ortargetGroups
can be specified. Default: - No fixed response.host_header (
Optional
[str
]) – (deprecated) Rule applies if the requested host matches the indicated host. May contain up to three ‘*’ wildcards. Default: - No host condition.path_pattern (
Optional
[str
]) – (deprecated) Rule applies if the requested path matches the given path pattern. Default: - No path condition.path_patterns (
Optional
[Sequence
[str
]]) – (deprecated) Rule applies if the requested path matches any of the given patterns. Paths may contain up to three ‘*’ wildcards. Default: - No path conditions.redirect_response (
Union
[RedirectResponse
,Dict
[str
,Any
],None
]) – (deprecated) Redirect response to return. Only one ofaction
,fixedResponse
,redirectResponse
ortargetGroups
can be specified. Default: - No redirect response.target_groups (
Optional
[Sequence
[IApplicationTargetGroup
]]) – Target groups to forward requests to. Only one ofaction
,fixedResponse
,redirectResponse
ortargetGroups
can be specified. Implies aforward
action. Default: - No target groups.
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_elasticloadbalancingv2 as elbv2 # application_target_group: elbv2.ApplicationTargetGroup # listener_action: elbv2.ListenerAction # listener_condition: elbv2.ListenerCondition base_application_listener_rule_props = elbv2.BaseApplicationListenerRuleProps( priority=123, # the properties below are optional action=listener_action, conditions=[listener_condition], fixed_response=elbv2.FixedResponse( status_code="statusCode", # the properties below are optional content_type=elbv2.ContentType.TEXT_PLAIN, message_body="messageBody" ), host_header="hostHeader", path_pattern="pathPattern", path_patterns=["pathPatterns"], redirect_response=elbv2.RedirectResponse( status_code="statusCode", # the properties below are optional host="host", path="path", port="port", protocol="protocol", query="query" ), target_groups=[application_target_group] )
Attributes
-
action
¶ Action to perform when requests are received.
Only one of
action
,fixedResponse
,redirectResponse
ortargetGroups
can be specified.- Default
No action
- Return type
Optional
[ListenerAction
]
-
conditions
¶ Rule applies if matches the conditions.
- Default
No conditions.
- See
https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html
- Return type
Optional
[List
[ListenerCondition
]]
-
fixed_response
¶ (deprecated) Fixed response to return.
Only one of
action
,fixedResponse
,redirectResponse
ortargetGroups
can be specified.- Default
No fixed response.
- Deprecated
Use
action
instead.- Stability
deprecated
- Return type
Optional
[FixedResponse
]
-
host_header
¶ (deprecated) Rule applies if the requested host matches the indicated host.
May contain up to three ‘*’ wildcards.
- Default
No host condition.
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- Return type
Optional
[str
]
-
path_pattern
¶ (deprecated) Rule applies if the requested path matches the given path pattern.
- Default
No path condition.
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- Return type
Optional
[str
]
-
path_patterns
¶ (deprecated) Rule applies if the requested path matches any of the given patterns.
Paths may contain up to three ‘*’ wildcards.
- Default
No path conditions.
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- Return type
Optional
[List
[str
]]
-
priority
¶ Priority of the rule.
The rule with the lowest priority will be used for every request.
Priorities must be unique.
- Return type
Union
[int
,float
]
-
redirect_response
¶ (deprecated) Redirect response to return.
Only one of
action
,fixedResponse
,redirectResponse
ortargetGroups
can be specified.- Default
No redirect response.
- Deprecated
Use
action
instead.- Stability
deprecated
- Return type
Optional
[RedirectResponse
]
-
target_groups
¶ Target groups to forward requests to.
Only one of
action
,fixedResponse
,redirectResponse
ortargetGroups
can be specified.Implies a
forward
action.- Default
No target groups.
- Return type
Optional
[List
[IApplicationTargetGroup
]]