software.amazon.awscdk.services.globalaccelerator.endpoints

Class NetworkLoadBalancerEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.globalaccelerator.endpoints.NetworkLoadBalancerEndpoint

All Implemented Interfaces:

IEndpoint

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:10.149Z")
public class NetworkLoadBalancerEndpoint
extends software.amazon.jsii.JsiiObject
implements IEndpoint

Use a Network Load Balancer as a Global Accelerator Endpoint.

Example:

 // Create an Accelerator
 Accelerator accelerator = new Accelerator(this, "Accelerator");
 // Create a Listener
 Listener listener = accelerator.addListener("Listener", ListenerOptions.builder()
         .portRanges(List.of(PortRange.builder().fromPort(80).build(), PortRange.builder().fromPort(443).build()))
         .build());
 // Import the Load Balancers
 INetworkLoadBalancer nlb1 = NetworkLoadBalancer.fromNetworkLoadBalancerAttributes(this, "NLB1", NetworkLoadBalancerAttributes.builder()
         .loadBalancerArn("arn:aws:elasticloadbalancing:us-west-2:111111111111:loadbalancer/app/my-load-balancer1/e16bef66805b")
         .build());
 INetworkLoadBalancer nlb2 = NetworkLoadBalancer.fromNetworkLoadBalancerAttributes(this, "NLB2", NetworkLoadBalancerAttributes.builder()
         .loadBalancerArn("arn:aws:elasticloadbalancing:ap-south-1:111111111111:loadbalancer/app/my-load-balancer2/5513dc2ea8a1")
         .build());
 // Add one EndpointGroup for each Region we are targeting
 listener.addEndpointGroup("Group1", EndpointGroupOptions.builder()
         .endpoints(List.of(new NetworkLoadBalancerEndpoint(nlb1)))
         .build());
 listener.addEndpointGroup("Group2", EndpointGroupOptions.builder()
         // Imported load balancers automatically calculate their Region from the ARN.
         // If you are load balancing to other resources, you must also pass a `region`
         // parameter here.
         .endpoints(List.of(new NetworkLoadBalancerEndpoint(nlb2)))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkLoadBalancerEndpoint.Builder A fluent builder for NetworkLoadBalancerEndpoint.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.globalaccelerator.IEndpoint

IEndpoint.Jsii$Default, IEndpoint.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	NetworkLoadBalancerEndpoint(INetworkLoadBalancer loadBalancer, NetworkLoadBalancerEndpointProps options)
protected	NetworkLoadBalancerEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkLoadBalancerEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRegion() The region where the endpoint is located.
java.lang.Object	renderEndpointConfiguration() Render the endpoint to an endpoint configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkLoadBalancerEndpoint

protected NetworkLoadBalancerEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

NetworkLoadBalancerEndpoint

protected NetworkLoadBalancerEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NetworkLoadBalancerEndpoint

public NetworkLoadBalancerEndpoint(INetworkLoadBalancer loadBalancer,
                                   NetworkLoadBalancerEndpointProps options)

Parameters:

loadBalancer - This parameter is required.

options -

Method Detail

renderEndpointConfiguration

public java.lang.Object renderEndpointConfiguration()

Render the endpoint to an endpoint configuration.

Specified by:

renderEndpointConfiguration in interface IEndpoint

getRegion

public java.lang.String getRegion()

The region where the endpoint is located.

If the region cannot be determined, undefined is returned

Specified by:

getRegion in interface IEndpoint