Skip to content
v2.275.0

INetworkLoadBalancer Interface ​

A network load balancer.

Properties ​

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#
The network connections associated with this resource.
enforceSecurityGroupInboundRulesOnPrivateLinkTrafficmay be undefinedstringenforce_security_group_inbound_rules_on_private_link_trafficmay be undefinedstrenforceSecurityGroupInboundRulesOnPrivateLinkTrafficmay be undefinedStringEnforceSecurityGroupInboundRulesOnPrivateLinkTrafficmay be undefinedstringEnforceSecurityGroupInboundRulesOnPrivateLinkTrafficmay be undefined*string= on#
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.
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.

ipAddressTypemay be undefinedIpAddressTypeip_address_typemay be undefinedIpAddressTypeipAddressTypemay be undefinedIpAddressTypeIpAddressTypemay be undefinedIpAddressTypeIpAddressTypemay be undefinedIpAddressType= IpAddressType.IPV4#
The type of IP addresses to use.
loadBalancerArnstringload_balancer_arnstrloadBalancerArnStringLoadBalancerArnstringLoadBalancerArn*string#
The ARN of the load balancer that hosts the VPC Endpoint Service.
loadBalancerCanonicalHostedZoneIdstringload_balancer_canonical_hosted_zone_idstrloadBalancerCanonicalHostedZoneIdStringLoadBalancerCanonicalHostedZoneIdstringLoadBalancerCanonicalHostedZoneId*string#
The canonical hosted zone ID of this load balancer.

Example value: Z2P70J7EXAMPLE

loadBalancerDnsNamestringload_balancer_dns_namestrloadBalancerDnsNameStringLoadBalancerDnsNamestringLoadBalancerDnsName*string#
The DNS name of this load balancer.

Example value: my-load-balancer-424835706.us-west-2.elb.amazonaws.com

loadBalancerRefLoadBalancerReferenceload_balancer_refLoadBalancerReferenceloadBalancerRefLoadBalancerReferenceLoadBalancerRefLoadBalancerReferenceLoadBalancerRefLoadBalancerReference#
A reference to a LoadBalancer resource.
nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
securityGroupsmay be undefinedstring[]security_groupsmay be undefinedtyping.List[str]securityGroupsmay be undefinedList<String>SecurityGroupsmay be undefinedstring[]SecurityGroupsmay be undefined*[]*string#
Security groups associated with this load balancer.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.
vpcmay be undefinedIVpcvpcmay be undefinedIVpcvpcmay be undefinedIVpcVpcmay be undefinedIVpcVpcmay be undefinedIVpc#
The VPC this load balancer has been created in (if available).

Methods ​

addListener(id: string, props: BaseNetworkListenerProps): NetworkListenerdef add_listener(self, id: str, props: BaseNetworkListenerProps) -> NetworkListenerpublic NetworkListener addListener(String id, BaseNetworkListenerProps props)public NetworkListener AddListener(string id, BaseNetworkListenerProps props)func AddListener(Id *string, Props BaseNetworkListenerProps) NetworkListener#
Add a listener to this load balancer.
returns

Returns: The newly created listener

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

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