AWS CDK Reference

Appearance

v2.274.0

INetworkTargetGroup Interface ​

A network target group.

Source
aws-elasticloadbalancingv2/lib/nlb/network-target-group.ts
Type last changed
v2.234.0 · 8 Jan 2026

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

isNetworkTargetGroupbooleanis_network_target_groupboolisNetworkTargetGroupBooleanIsNetworkTargetGroupboolIsNetworkTargetGroup*boolrequired#
Indicates that this is a Network Target Group.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

loadBalancerArnsstringload_balancer_arnsstrloadBalancerArnsStringLoadBalancerArnsstringLoadBalancerArns*stringrequired#
A token representing a list of ARNs of the load balancers that route traffic to this target group.
loadBalancerAttachedIDependableload_balancer_attachedIDependableloadBalancerAttachedIDependableLoadBalancerAttachedIDependableLoadBalancerAttachedIDependablerequired#
Return an object to depend on the listeners added to this target group.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
targetGroupArnstringtarget_group_arnstrtargetGroupArnStringTargetGroupArnstringTargetGroupArn*stringrequired#
ARN of the target group.
targetGroupNamestringtarget_group_namestrtargetGroupNameStringTargetGroupNamestringTargetGroupName*stringrequired#
The name of the target group.
targetGroupRefTargetGroupReferencetarget_group_refTargetGroupReferencetargetGroupRefTargetGroupReferenceTargetGroupRefTargetGroupReferenceTargetGroupRefTargetGroupReferencerequired#
A reference to a TargetGroup resource.

Methods ​

addTarget(...targets: INetworkLoadBalancerTarget[]): voiddef add_target(self, targets: INetworkLoadBalancerTarget) -> Nonepublic void addTarget(INetworkLoadBalancerTarget targets)public void AddTarget(INetworkLoadBalancerTarget targets)func AddTarget(Targets INetworkLoadBalancerTarget)#
Add a load balancing target to this target group.
registerListener(listener: INetworkListenerRef): voiddef register_listener(self, listener: INetworkListenerRef) -> Nonepublic void registerListener(INetworkListenerRef listener)public void RegisterListener(INetworkListenerRef listener)func RegisterListener(Listener INetworkListenerRef)#
Register a listener that is load balancing to this target group.

Don't call this directly. It will be called by listeners.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining