Package software.amazon.awscdk.services.globalaccelerator

Class CfnListener.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.CfnListener.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnListener>

Enclosing class:

CfnListener

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

A fluent builder for CfnListener.

Method Summary

Modifier and Type	Method	Description
CfnListener.Builder	acceleratorArn(String acceleratorArn)	The Amazon Resource Name (ARN) of your accelerator.
CfnListener	build()
CfnListener.Builder	clientAffinity(String 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.
static CfnListener.Builder	create(software.constructs.Construct scope, String id)
CfnListener.Builder	portRanges(List<? extends Object> portRanges)	The list of port ranges for the connections from clients to the accelerator.
CfnListener.Builder	portRanges(IResolvable portRanges)	The list of port ranges for the connections from clients to the accelerator.
CfnListener.Builder	protocol(String protocol)	The protocol for the connections from clients to the accelerator.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnListener.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnListener.Builder.

acceleratorArn

@Stability(Stable)
public CfnListener.Builder acceleratorArn(String acceleratorArn)

The Amazon Resource Name (ARN) of your accelerator.

Parameters:

acceleratorArn - The Amazon Resource Name (ARN) of your accelerator. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-acceleratorarn

portRanges

@Stability(Stable)
public CfnListener.Builder portRanges(IResolvable portRanges)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-portranges

portRanges

@Stability(Stable)
public CfnListener.Builder portRanges(List<? extends Object> portRanges)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-portranges

protocol

@Stability(Stable)
public CfnListener.Builder protocol(String protocol)

The protocol for the connections from clients to the accelerator.

Default: - "TCP"

Parameters:

protocol - The protocol for the connections from clients to the accelerator. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-protocol

clientAffinity

@Stability(Stable)
public CfnListener.Builder clientAffinity(String 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 .

Default: - "NONE"

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-clientaffinity

build

@Stability(Stable)
public CfnListener build()

Specified by:

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

Returns:

a newly built instance of CfnListener.