Interface ICfnListenerProps
Properties for defining a CfnListener
.
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.AWS.GlobalAccelerator.dll
Syntax (csharp)
public interface ICfnListenerProps
Syntax (vb)
Public Interface ICfnListenerProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GlobalAccelerator;
var cfnListenerProps = new CfnListenerProps {
AcceleratorArn = "acceleratorArn",
PortRanges = new [] { new PortRangeProperty {
FromPort = 123,
ToPort = 123
} },
Protocol = "protocol",
// the properties below are optional
ClientAffinity = "clientAffinity"
};
Synopsis
Properties
AcceleratorArn | The Amazon Resource Name (ARN) of your accelerator. |
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. |
PortRanges | The list of port ranges for the connections from clients to the accelerator. |
Protocol | The protocol for the connections from clients to the accelerator. |
Properties
AcceleratorArn
The Amazon Resource Name (ARN) of your accelerator.
string AcceleratorArn { get; }
Property Value
System.String
Remarks
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.
virtual string ClientAffinity { get; }
Property Value
System.String
Remarks
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
.
PortRanges
The list of port ranges for the connections from clients to the accelerator.
object PortRanges { get; }
Property Value
System.Object
Remarks
Protocol
The protocol for the connections from clients to the accelerator.
string Protocol { get; }
Property Value
System.String