CreateListenerRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-global-accelerator/refs/heads/main/json-schema/global-accelerator-create-listener-request-schema.json",
  "title": "CreateListenerRequest",
  "description": "CreateListenerRequest schema from Amazon Global Accelerator API",
  "type": "object",
  "properties": {
    "AcceleratorArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The Amazon Resource Name (ARN) of your accelerator."
        }
      ]
    },
    "PortRanges": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortRanges"
        },
        {
          "description": "The list of port ranges to support for connections from clients to your accelerator."
        }
      ]
    },
    "Protocol": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Protocol"
        },
        {
          "description": "The protocol for connections from clients to your accelerator."
        }
      ]
    },
    "ClientAffinity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientAffinity"
        },
        {
          "description": "<p>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.</p> <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the \"five-tuple\" (5-tuple) properties\u2014source IP address, source port, destination IP address, destination port, and protocol\u2014to 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. </p> <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties\u2014 source (client) IP address and destination IP address\u2014to select the hash value.</p> <p>The default value is <code>NONE</code>.</p>"
        }
      ]
    },
    "IdempotencyToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyToken"
        },
        {
          "description": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the uniqueness\u2014of the request."
        }
      ]
    }
  },
  "required": [
    "AcceleratorArn",
    "PortRanges",
    "Protocol",
    "IdempotencyToken"
  ]
}