GlobalAccelerator / Client / create_listener

create_listener#

GlobalAccelerator.Client.create_listener(**kwargs)#

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.

Request Syntax

response = client.create_listener(
    AcceleratorArn='string',
    PortRanges=[
        {
            'FromPort': 123,
            'ToPort': 123
        },
    ],
    Protocol='TCP'|'UDP',
    ClientAffinity='NONE'|'SOURCE_IP',
    IdempotencyToken='string'
)

Parameters:

AcceleratorArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of your accelerator.
PortRanges (list) –
[REQUIRED]

The list of port ranges to support for connections from clients to your accelerator.
- (dict) –
  
  A complex type for a range of ports for a listener.
  - FromPort (integer) –
    
    The first port in the range of ports, inclusive.
  - ToPort (integer) –
    
    The last port in the range of ports, inclusive.
Protocol (string) –
[REQUIRED]

The protocol for connections from clients to your accelerator.
ClientAffinity (string) –
Client 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.

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.
IdempotencyToken (string) –
[REQUIRED]

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Listener': {
        'ListenerArn': 'string',
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ],
        'Protocol': 'TCP'|'UDP',
        'ClientAffinity': 'NONE'|'SOURCE_IP'
    }
}

Response Structure

(dict) –
- Listener (dict) –
  
  The listener that you’ve created.
  - ListenerArn (string) –
    
    The Amazon Resource Name (ARN) of the listener.
  - PortRanges (list) –
    
    The list of port ranges for the connections from clients to the accelerator.
    - (dict) –
      
      A complex type for a range of ports for a listener.
      - FromPort (integer) –
        
        The first port in the range of ports, inclusive.
      - ToPort (integer) –
        
        The last port in the range of ports, inclusive.
  - Protocol (string) –
    
    The protocol for the connections from clients to the accelerator.
  - ClientAffinity (string) –
    
    Client 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.
    
    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.

Exceptions

GlobalAccelerator.Client.exceptions.InvalidArgumentException
GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException
GlobalAccelerator.Client.exceptions.InvalidPortRangeException
GlobalAccelerator.Client.exceptions.InternalServiceErrorException
GlobalAccelerator.Client.exceptions.LimitExceededException