AddNetworkTargetsProps¶
-
class
aws_cdk.aws_elasticloadbalancingv2.
AddNetworkTargetsProps
(*, port, deregistration_delay=None, health_check=None, preserve_client_ip=None, protocol=None, proxy_protocol_v2=None, target_group_name=None, targets=None)¶ Bases:
object
Properties for adding new network targets to a listener.
- Parameters
port (
Union
[int
,float
]) – The port on which the listener listens for requests. Default: Determined from protocol if knownderegistration_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: - The default value for each property in this configuration varies depending on the target.preserve_client_ip (
Optional
[bool
]) – Indicates whether client IP preservation is enabled. Default: false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.protocol (
Optional
[Protocol
]) – Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP. Default: - inherits the protocol of the listenerproxy_protocol_v2 (
Optional
[bool
]) – Indicates whether Proxy Protocol version 2 is enabled. Default: falsetarget_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
[Sequence
[INetworkLoadBalancerTarget
]]) – The targets to add to this target group. Can beInstance
,IPAddress
, or any self-registering load balancing target. If you use eitherInstance
orIPAddress
as targets, all target must be of the same type.
- ExampleMetadata
infused
Example:
from aws_cdk.aws_apigatewayv2_integrations import HttpNlbIntegration vpc = ec2.Vpc(self, "VPC") lb = elbv2.NetworkLoadBalancer(self, "lb", vpc=vpc) listener = lb.add_listener("listener", port=80) listener.add_targets("target", port=80 ) http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi", default_integration=HttpNlbIntegration("DefaultIntegration", listener) )
Attributes
-
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
The default value for each property in this configuration varies depending on the target.
- See
- Return type
Optional
[HealthCheck
]
-
port
¶ The port on which the listener listens for requests.
- Default
Determined from protocol if known
- Return type
Union
[int
,float
]
-
preserve_client_ip
¶ Indicates whether client IP preservation is enabled.
- Default
false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.
- Return type
Optional
[bool
]
-
protocol
¶ Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
- Default
inherits the protocol of the listener
- Return type
Optional
[Protocol
]
-
proxy_protocol_v2
¶ Indicates whether Proxy Protocol version 2 is enabled.
- Default
false
- Return type
Optional
[bool
]
-
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. If you use eitherInstance
orIPAddress
as targets, all target must be of the same type.- Return type
Optional
[List
[INetworkLoadBalancerTarget
]]