CreateEndpointGroupRequest

{
  "$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-endpoint-group-request-schema.json",
  "title": "CreateEndpointGroupRequest",
  "description": "CreateEndpointGroupRequest schema from Amazon Global Accelerator API",
  "type": "object",
  "properties": {
    "ListenerArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the listener."
        }
      ]
    },
    "EndpointGroupRegion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region."
        }
      ]
    },
    "EndpointConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EndpointConfigurations"
        },
        {
          "description": "The list of endpoint objects."
        }
      ]
    },
    "TrafficDialPercentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TrafficDialPercentage"
        },
        {
          "description": "<p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>"
        }
      ]
    },
    "HealthCheckPort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HealthCheckPort"
        },
        {
          "description": "The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list."
        }
      ]
    },
    "HealthCheckProtocol": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HealthCheckProtocol"
        },
        {
          "description": "The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP."
        }
      ]
    },
    "HealthCheckPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HealthCheckPath"
        },
        {
          "description": "If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/)."
        }
      ]
    },
    "HealthCheckIntervalSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HealthCheckIntervalSeconds"
        },
        {
          "description": "The time\u201410 seconds or 30 seconds\u2014between each health check for an endpoint. The default value is 30."
        }
      ]
    },
    "ThresholdCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThresholdCount"
        },
        {
          "description": "The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3."
        }
      ]
    },
    "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."
        }
      ]
    },
    "PortOverrides": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortOverrides"
        },
        {
          "description": "<p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html\"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>"
        }
      ]
    }
  },
  "required": [
    "ListenerArn",
    "EndpointGroupRegion",
    "IdempotencyToken"
  ]
}