Package software.amazon.awscdk.services.globalaccelerator

Class CfnListenerProps.Builder

java.lang.Object
software.amazon.awscdk.services.globalaccelerator.CfnListenerProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnListenerProps>
Enclosing interface:
CfnListenerProps
@Stability(Stable) public static final class CfnListenerProps.Builder extends Object implements software.amazon.jsii.Builder<CfnListenerProps>
A builder for CfnListenerProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • acceleratorArn

      @Stability(Stable) public CfnListenerProps.Builder acceleratorArn(String acceleratorArn)
      Sets the value of CfnListenerProps.getAcceleratorArn()
      Parameters:
      acceleratorArn - The Amazon Resource Name (ARN) of your accelerator. This parameter is required.
      Returns:
      this

    • portRanges

      @Stability(Stable) public CfnListenerProps.Builder portRanges(IResolvable portRanges)
      Sets the value of CfnListenerProps.getPortRanges()
      Parameters:
      portRanges - The list of port ranges for the connections from clients to the accelerator. This parameter is required.
      Returns:
      this

    • portRanges

      @Stability(Stable) public CfnListenerProps.Builder portRanges(List<? extends Object> portRanges)
      Sets the value of CfnListenerProps.getPortRanges()
      Parameters:
      portRanges - The list of port ranges for the connections from clients to the accelerator. This parameter is required.
      Returns:
      this

    • protocol

      @Stability(Stable) public CfnListenerProps.Builder protocol(String protocol)
      Sets the value of CfnListenerProps.getProtocol()
      Parameters:
      protocol - The protocol for the connections from clients to the accelerator. This parameter is required.
      Returns:
      this

    • clientAffinity

      @Stability(Stable) public CfnListenerProps.Builder clientAffinity(String clientAffinity)
      Sets the value of CfnListenerProps.getClientAffinity()
      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. 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 .

      Returns:
      this

    • build

      @Stability(Stable) public CfnListenerProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnListenerProps>
      Returns:
      a new instance of CfnListenerProps
      Throws:
      NullPointerException - if any required attribute was not provided