UpdateListenerCommand

Suggest an Edit

Update a listener.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlobalAcceleratorClient, UpdateListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import
// const { GlobalAcceleratorClient, UpdateListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import
const client = new GlobalAcceleratorClient(config);
const input = { // UpdateListenerRequest
  ListenerArn: "STRING_VALUE", // required
  PortRanges: [ // PortRanges
    { // PortRange
      FromPort: Number("int"),
      ToPort: Number("int"),
    },
  ],
  Protocol: "TCP" || "UDP",
  ClientAffinity: "NONE" || "SOURCE_IP",
};
const command = new UpdateListenerCommand(input);
const response = await client.send(command);
// { // UpdateListenerResponse
//   Listener: { // Listener
//     ListenerArn: "STRING_VALUE",
//     PortRanges: [ // PortRanges
//       { // PortRange
//         FromPort: Number("int"),
//         ToPort: Number("int"),
//       },
//     ],
//     Protocol: "TCP" || "UDP",
//     ClientAffinity: "NONE" || "SOURCE_IP",
//   },
// };

UpdateListenerCommand Input

See UpdateListenerCommandInput for more details

Parameter
Type
Description
ListenerArn
Required
string | undefined

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

ClientAffinity
ClientAffinity | undefined

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.

PortRanges
PortRange[] | undefined

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

Protocol
Protocol | undefined

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

UpdateListenerCommand Output

See UpdateListenerCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Listener
Listener | undefined

Information for the updated listener.

Throws

Name
Fault
Details
InternalServiceErrorException
server

There was an internal error for Global Accelerator.

InvalidArgumentException
client

An argument that you specified is invalid.

InvalidPortRangeException
client

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

LimitExceededException
client

Processing your request would cause you to exceed an Global Accelerator limit.

ListenerNotFoundException
client

The listener that you specified doesn't exist.

GlobalAcceleratorServiceException
Base exception class for all service exceptions from GlobalAccelerator service.