AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Listener

import "github.com/aws/aws-sdk-go/service/globalaccelerator"

type Listener struct { ClientAffinity *string `type:"string" enum:"ClientAffinity"` ListenerArn *string `type:"string"` PortRanges []*PortRange `min:"1" type:"list"` Protocol *string `type:"string" enum:"Protocol"` }

A complex type for a listener.

ClientAffinity

Type: *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. Clienty 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.

ListenerArn

Type: *string

The Amazon Resource Name (ARN) of the listener.

PortRanges

A complex type for a range of ports for a listener.

Protocol

Type: *string

The protocol for the connections from clients to the accelerator.

Method

GoString

func (s Listener) GoString() string

GoString returns the string representation

SetClientAffinity

func (s *Listener) SetClientAffinity(v string) *Listener

SetClientAffinity sets the ClientAffinity field's value.

SetListenerArn

func (s *Listener) SetListenerArn(v string) *Listener

SetListenerArn sets the ListenerArn field's value.

SetPortRanges

func (s *Listener) SetPortRanges(v []*PortRange) *Listener

SetPortRanges sets the PortRanges field's value.

SetProtocol

func (s *Listener) SetProtocol(v string) *Listener

SetProtocol sets the Protocol field's value.

String

func (s Listener) String() string

String returns the string representation

On this page: