Package software.amazon.awssdk.services.globalaccelerator.model

Interface CreateListenerRequest.Builder

    • Method Detail

      • acceleratorArn

        CreateListenerRequest.Builder acceleratorArn​(String acceleratorArn)

        The Amazon Resource Name (ARN) of your accelerator.

        Parameters:
        acceleratorArn - The Amazon Resource Name (ARN) of your accelerator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portRanges

        CreateListenerRequest.Builder portRanges​(Collection<PortRange> portRanges)

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

        Parameters:
        portRanges - The list of port ranges to support for connections from clients to your accelerator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portRanges

        CreateListenerRequest.Builder portRanges​(PortRange... portRanges)

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

        Parameters:
        portRanges - The list of port ranges to support for connections from clients to your accelerator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • protocol

        CreateListenerRequest.Builder protocol​(String protocol)

        The protocol for connections from clients to your accelerator.

        Parameters:
        protocol - The protocol for connections from clients to your accelerator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Protocol, Protocol

      • protocol

        CreateListenerRequest.Builder protocol​(Protocol protocol)

        The protocol for connections from clients to your accelerator.

        Parameters:
        protocol - The protocol for connections from clients to your accelerator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Protocol, Protocol

      • clientAffinity

        CreateListenerRequest.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.

        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.

        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.

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClientAffinity, ClientAffinity

      • clientAffinity

        CreateListenerRequest.Builder clientAffinity​(ClientAffinity 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.

        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.

        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.

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClientAffinity, ClientAffinity

      • idempotencyToken

        CreateListenerRequest.Builder idempotencyToken​(String idempotencyToken)

        A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

        Parameters:
        idempotencyToken - A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.