ListenerOptions
- class aws_cdk.aws_globalaccelerator.ListenerOptions(*, port_ranges, client_affinity=None, listener_name=None, protocol=None)
Bases:
object
Construct options for Listener.
- Parameters:
port_ranges (
Sequence
[Union
[PortRange
,Dict
[str
,Any
]]]) – The list of port ranges for the connections from clients to the accelerator.client_affinity (
Optional
[ClientAffinity
]) – Client affinity to direct all requests from a user to the same endpoint. If you have stateful applications, client affinity lets you direct all requests from a user to the same endpoint. By default, each connection from each client is routed to seperate endpoints. Set client affinity to SOURCE_IP to route all connections from a single client to the same endpoint. Default: ClientAffinity.NONElistener_name (
Optional
[str
]) – Name of the listener. Default: - logical ID of the resourceprotocol (
Optional
[ConnectionProtocol
]) – The protocol for the connections from clients to the accelerator. Default: ConnectionProtocol.TCP
- ExampleMetadata:
infused
Example:
# Create an Accelerator accelerator = globalaccelerator.Accelerator(self, "Accelerator") # Create a Listener listener = accelerator.add_listener("Listener", port_ranges=[globalaccelerator.PortRange(from_port=80), globalaccelerator.PortRange(from_port=443) ] ) # Import the Load Balancers nlb1 = elbv2.NetworkLoadBalancer.from_network_load_balancer_attributes(self, "NLB1", load_balancer_arn="arn:aws:elasticloadbalancing:us-west-2:111111111111:loadbalancer/app/my-load-balancer1/e16bef66805b" ) nlb2 = elbv2.NetworkLoadBalancer.from_network_load_balancer_attributes(self, "NLB2", load_balancer_arn="arn:aws:elasticloadbalancing:ap-south-1:111111111111:loadbalancer/app/my-load-balancer2/5513dc2ea8a1" ) # Add one EndpointGroup for each Region we are targeting listener.add_endpoint_group("Group1", endpoints=[ga_endpoints.NetworkLoadBalancerEndpoint(nlb1)] ) listener.add_endpoint_group("Group2", # 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=[ga_endpoints.NetworkLoadBalancerEndpoint(nlb2)] )
Attributes
- client_affinity
Client affinity to direct all requests from a user to the same endpoint.
If you have stateful applications, client affinity lets you direct all requests from a user to the same endpoint.
By default, each connection from each client is routed to seperate endpoints. Set client affinity to SOURCE_IP to route all connections from a single client to the same endpoint.
- Default:
ClientAffinity.NONE
- listener_name
Name of the listener.
- Default:
logical ID of the resource
- port_ranges
The list of port ranges for the connections from clients to the accelerator.
- protocol
The protocol for the connections from clients to the accelerator.
- Default:
ConnectionProtocol.TCP