AWS::GlobalAccelerator::ListenerThe `AWS::GlobalAccelerator::Listener` resource is a Global Accelerator resource type that contains information about how you create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
import { CfnListener } from 'aws-cdk-lib/aws-globalaccelerator';Or use the module namespace:
import * as globalaccelerator from 'aws-cdk-lib/aws-globalaccelerator';
// globalaccelerator.CfnListenerConfiguration passed to the constructor as CfnListenerProps.
acceleratorArnRequiredstring | IAcceleratorRefThe Amazon Resource Name (ARN) of your accelerator.
portRangesRequiredIResolvable | IResolvable | PortRangeProperty[]The list of port ranges for the connections from clients to the accelerator.
protocolRequiredstringThe protocol for the connections from clients to the accelerator.
Default: - "TCP"
clientAffinityOptionalstringClient affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is `NONE` , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to `SOURCE_IP` instead. When you use the `SOURCE_IP` setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is `NONE` .
Default: - "NONE"
This L1 construct maps directly to the following CloudFormation resource type.
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-globalacceleratorAWS::GlobalAccelerator::Listener