Package software.amazon.awscdk.services.globalaccelerator

Class ListenerOptions.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.ListenerOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ListenerOptions>

Enclosing interface:

ListenerOptions

@Stability(Stable)
public static final class ListenerOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ListenerOptions>

A builder for ListenerOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListenerOptions	build()	Builds the configured instance.
ListenerOptions.Builder	clientAffinity(ClientAffinity clientAffinity)	Sets the value of ListenerOptions.getClientAffinity()
ListenerOptions.Builder	listenerName(String listenerName)	Sets the value of ListenerOptions.getListenerName()
ListenerOptions.Builder	portRanges(List<? extends PortRange> portRanges)	Sets the value of ListenerOptions.getPortRanges()
ListenerOptions.Builder	protocol(ConnectionProtocol protocol)	Sets the value of ListenerOptions.getProtocol()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

portRanges

@Stability(Stable)
public ListenerOptions.Builder portRanges(List<? extends PortRange> portRanges)

Sets the value of ListenerOptions.getPortRanges()

Parameters:

portRanges - The list of port ranges for the connections from clients to the accelerator. This parameter is required.

Returns:

this

clientAffinity

@Stability(Stable)
public ListenerOptions.Builder clientAffinity(ClientAffinity clientAffinity)

Sets the value of ListenerOptions.getClientAffinity()

Parameters:

clientAffinity - Client affinity to direct all requests from a user to the same endpoint. If you have stateful applications, client affinity lets you direct all requests from a user to the same endpoint.

By default, each connection from each client is routed to seperate endpoints. Set client affinity to SOURCE_IP to route all connections from a single client to the same endpoint.

Returns:

this

listenerName

@Stability(Stable)
public ListenerOptions.Builder listenerName(String listenerName)

Sets the value of ListenerOptions.getListenerName()

Parameters:

listenerName - Name of the listener.

Returns:

this

protocol

@Stability(Stable)
public ListenerOptions.Builder protocol(ConnectionProtocol protocol)

Sets the value of ListenerOptions.getProtocol()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public ListenerOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ListenerOptions>

Returns:

a new instance of ListenerOptions

Throws:

NullPointerException - if any required attribute was not provided