Package software.amazon.awscdk.services.globalaccelerator

Interface CfnListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.384Z")
@Stability(Stable)
public interface CfnListenerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnListener.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.globalaccelerator.*;
 CfnListenerProps cfnListenerProps = CfnListenerProps.builder()
         .acceleratorArn("acceleratorArn")
         .portRanges(List.of(PortRangeProperty.builder()
                 .fromPort(123)
                 .toPort(123)
                 .build()))
         .protocol("protocol")
         // the properties below are optional
         .clientAffinity("clientAffinity")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnListenerProps.Builder	A builder for CfnListenerProps
static final class	CfnListenerProps.Jsii$Proxy	An implementation for CfnListenerProps

Method Summary

Modifier and Type	Method	Description
static CfnListenerProps.Builder	builder()
String	getAcceleratorArn()	The Amazon Resource Name (ARN) of your accelerator.
default String	getClientAffinity()	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.
Object	getPortRanges()	The list of port ranges for the connections from clients to the accelerator.
String	getProtocol()	The protocol for the connections from clients to the accelerator.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcceleratorArn

@Stability(Stable)
@NotNull
String getAcceleratorArn()

The Amazon Resource Name (ARN) of your accelerator.

See Also:

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

getPortRanges

@Stability(Stable)
@NotNull
Object getPortRanges()

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

See Also:

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

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

The protocol for the connections from clients to the accelerator.

Default: - "TCP"

See Also:

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

getClientAffinity

@Stability(Stable)
@Nullable
default String getClientAffinity()

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"

See Also:

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

builder

@Stability(Stable)
static CfnListenerProps.Builder builder()

Returns:

a CfnListenerProps.Builder of CfnListenerProps