AddApplicationTargetsProps¶
-
class
aws_cdk.aws_elasticloadbalancingv2.
AddApplicationTargetsProps
(*, conditions=None, host_header=None, path_pattern=None, path_patterns=None, priority=None, deregistration_delay=None, health_check=None, port=None, protocol=None, slow_start=None, stickiness_cookie_duration=None, target_group_name=None, targets=None)¶ Bases:
aws_cdk.aws_elasticloadbalancingv2.AddRuleProps
Properties for adding new targets to a listener.
- Parameters
conditions (
Optional
[List
[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
[List
[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 defaultsderegistration_delay (
Optional
[Duration
]) – The amount of time for Elastic Load Balancing to wait before deregistering a target. The range is 0-3600 seconds. Default: Duration.minutes(5)health_check (
Optional
[HealthCheck
]) – Health check configuration. Default: No health checkport (
Union
[int
,float
,None
]) – The port on which the listener listens for requests. Default: Determined from protocol if knownprotocol (
Optional
[ApplicationProtocol
]) – The protocol to use. Default: Determined from port if knownslow_start (
Optional
[Duration
]) – The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group. The range is 30-900 seconds (15 minutes). Default: 0stickiness_cookie_duration (
Optional
[Duration
]) – The stickiness cookie expiration period. Setting this value enables load balancer stickiness. After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds). Default: Stickiness disabledtarget_group_name (
Optional
[str
]) – The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. Default: Automatically generatedtargets (
Optional
[List
[IApplicationLoadBalancerTarget
]]) – The targets to add to this target group. Can beInstance
,IPAddress
, or any self-registering load balancing target. All target must be of the same type.
Attributes
-
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
]]
-
deregistration_delay
¶ The amount of time for Elastic Load Balancing to wait before deregistering a target.
The range is 0-3600 seconds.
- Default
Duration.minutes(5)
- Return type
Optional
[Duration
]
-
health_check
¶ Health check configuration.
- Default
No health check
- Return type
Optional
[HealthCheck
]
-
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
- Return type
Optional
[str
]
-
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
- Return type
Optional
[str
]
-
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
- Return type
Optional
[List
[str
]]
-
port
¶ The port on which the listener listens for requests.
- Default
Determined from protocol if known
- Return type
Union
[int
,float
,None
]
-
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
- Return type
Union
[int
,float
,None
]
-
protocol
¶ The protocol to use.
- Default
Determined from port if known
- Return type
Optional
[ApplicationProtocol
]
-
slow_start
¶ The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.
The range is 30-900 seconds (15 minutes).
- Default
0
- Return type
Optional
[Duration
]
The stickiness cookie expiration period.
Setting this value enables load balancer stickiness.
After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds).
- Default
Stickiness disabled
- Return type
Optional
[Duration
]
-
target_group_name
¶ The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- Default
Automatically generated
- Return type
Optional
[str
]
-
targets
¶ The targets to add to this target group.
Can be
Instance
,IPAddress
, or any self-registering load balancing target. All target must be of the same type.- Return type
Optional
[List
[IApplicationLoadBalancerTarget
]]