updateListener method

Future<UpdateListenerResponse> updateListener({ required String listenerArn, ClientAffinity? clientAffinity, List<PortRange>? portRanges, Protocol? protocol, })

Update a listener.

May throw InvalidArgumentException. May throw InvalidPortRangeException. May throw ListenerNotFoundException. May throw InternalServiceErrorException. May throw LimitExceededException.

Parameter listenerArn : The Amazon Resource Name (ARN) of the listener to update.

Parameter clientAffinity : 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.

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.

Parameter portRanges : The updated list of port ranges for the connections from clients to the accelerator.

Parameter protocol : The updated protocol for the connections from clients to the accelerator.

Implementation

Future<UpdateListenerResponse> updateListener({
  required String listenerArn,
  ClientAffinity? clientAffinity,
  List<PortRange>? portRanges,
  Protocol? protocol,
}) async {
  ArgumentError.checkNotNull(listenerArn, 'listenerArn');
  _s.validateStringLength(
    'listenerArn',
    listenerArn,
    0,
    255,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GlobalAccelerator_V20180706.UpdateListener'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ListenerArn': listenerArn,
      if (clientAffinity != null) 'ClientAffinity': clientAffinity.toValue(),
      if (portRanges != null) 'PortRanges': portRanges,
      if (protocol != null) 'Protocol': protocol.toValue(),
    },
  );

  return UpdateListenerResponse.fromJson(jsonResponse.body);
}