AddRedirectResponseProps
- class aws_cdk.aws_elasticloadbalancingv2.AddRedirectResponseProps(*, conditions=None, host_header=None, path_pattern=None, path_patterns=None, priority=None, status_code, host=None, path=None, port=None, protocol=None, query=None)
Bases:
AddRuleProps
,RedirectResponse
(deprecated) Properties for adding a redirect response to a listener.
- Parameters
conditions (
Optional
[Sequence
[ListenerCondition
]]) – Rule applies if matches the conditions. Default: - No conditions.host_header (
Optional
[str
]) – (deprecated) Rule applies if the requested host matches the indicated host. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No host conditionpath_pattern (
Optional
[str
]) – (deprecated) Rule applies if the requested path matches the given path pattern. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No path conditionpath_patterns (
Optional
[Sequence
[str
]]) – (deprecated) Rule applies if the requested path matches any of the given patterns. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: - No path condition.priority (
Union
[int
,float
,None
]) – Priority of this target group. The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions. Priorities must be unique. Default: Target groups are used as defaultsstatus_code (
str
) – (deprecated) The HTTP redirect code (HTTP_301 or HTTP_302).host (
Optional
[str
]) – (deprecated) The hostname. This component is not percent-encoded. The hostname can contain #{host}. Default: origin host of requestpath (
Optional
[str
]) – (deprecated) The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Default: origin path of requestport (
Optional
[str
]) – (deprecated) The port. You can specify a value from 1 to 65535 or #{port}. Default: origin port of requestprotocol (
Optional
[str
]) – (deprecated) The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Default: origin protocol of requestquery (
Optional
[str
]) – (deprecated) The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”, as it is automatically added. You can specify any of the reserved keywords. Default: origin query string of request
- Deprecated
Use
ApplicationListener.addAction
instead.- Stability
deprecated
- 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 # listener_condition: elbv2.ListenerCondition add_redirect_response_props = elbv2.AddRedirectResponseProps( status_code="statusCode", # the properties below are optional conditions=[listener_condition], host="host", host_header="hostHeader", path="path", path_pattern="pathPattern", path_patterns=["pathPatterns"], port="port", priority=123, protocol="protocol", query="query" )
Attributes
- conditions
Rule applies if matches the conditions.
- Default
No conditions.
- See
https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html
- host
(deprecated) The hostname.
This component is not percent-encoded. The hostname can contain #{host}.
- Default
origin host of request
- Stability
deprecated
- host_header
(deprecated) Rule applies if the requested host matches the indicated host.
May contain up to three ‘*’ wildcards.
Requires that priority is set.
- Default
No host condition
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- path
(deprecated) The absolute path, starting with the leading “/”.
This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
- Default
origin path of request
- Stability
deprecated
- path_pattern
(deprecated) Rule applies if the requested path matches the given path pattern.
May contain up to three ‘*’ wildcards.
Requires that priority is set.
- Default
No path condition
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- path_patterns
(deprecated) Rule applies if the requested path matches any of the given patterns.
May contain up to three ‘*’ wildcards.
Requires that priority is set.
- Default
No path condition.
- Deprecated
Use
conditions
instead.- See
- Stability
deprecated
- port
(deprecated) The port.
You can specify a value from 1 to 65535 or #{port}.
- Default
origin port of request
- Stability
deprecated
- priority
Priority of this target group.
The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions.
Priorities must be unique.
- Default
Target groups are used as defaults
- protocol
(deprecated) The protocol.
You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
- Default
origin protocol of request
- Stability
deprecated
- query
(deprecated) The query parameters, URL-encoded when necessary, but not percent-encoded.
Do not include the leading “?”, as it is automatically added. You can specify any of the reserved keywords.
- Default
origin query string of request
- Stability
deprecated
- status_code
(deprecated) The HTTP redirect code (HTTP_301 or HTTP_302).
- Stability
deprecated