software.amazon.awscdk.services.globalaccelerator

Class ListenerProps.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.ListenerProps.Builder

Enclosing interface:

ListenerProps

public static final class ListenerProps.Builder
extends java.lang.Object

A builder for ListenerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListenerProps.Builder	accelerator(IAccelerator accelerator) Sets the value of ListenerProps.getAccelerator()
ListenerProps	build() Builds the configured instance.
ListenerProps.Builder	clientAffinity(ClientAffinity clientAffinity) Sets the value of ListenerOptions.getClientAffinity()
ListenerProps.Builder	listenerName(java.lang.String listenerName) Sets the value of ListenerOptions.getListenerName()
ListenerProps.Builder	portRanges(java.util.List<? extends PortRange> portRanges) Sets the value of ListenerOptions.getPortRanges()
ListenerProps.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 Detail

Builder

public Builder()

Method Detail

accelerator

public ListenerProps.Builder accelerator(IAccelerator accelerator)

Sets the value of ListenerProps.getAccelerator()

Parameters:

accelerator - The accelerator for this listener. This parameter is required.

Returns:

this

portRanges

public ListenerProps.Builder portRanges(java.util.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

public ListenerProps.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

public ListenerProps.Builder listenerName(java.lang.String listenerName)

Sets the value of ListenerOptions.getListenerName()

Parameters:

listenerName - Name of the listener.

Returns:

this

protocol

public ListenerProps.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

public ListenerProps build()

Builds the configured instance.

Returns:

a new instance of ListenerProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided