AllowCustomRoutingTrafficRequest

AllowCustomRoutingTrafficRequest schema from Amazon Global Accelerator API

AvailabilityCDNGlobalLoad BalancingNetworkingPerformance

Properties

Name Type Description
EndpointGroupArn object
EndpointId object
DestinationAddresses object
DestinationPorts object
AllowAllTrafficToEndpoint object
View JSON Schema on GitHub

JSON Schema

global-accelerator-allow-custom-routing-traffic-request-schema.json Raw ↑
{
  "$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-allow-custom-routing-traffic-request-schema.json",
  "title": "AllowCustomRoutingTrafficRequest",
  "description": "AllowCustomRoutingTrafficRequest schema from Amazon Global Accelerator API",
  "type": "object",
  "properties": {
    "EndpointGroupArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the endpoint group."
        }
      ]
    },
    "EndpointId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID."
        }
      ]
    },
    "DestinationAddresses": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DestinationAddresses"
        },
        {
          "description": "<p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.</p> <p> <code>DestinationAddresses</code> is required if <code>AllowAllTrafficToEndpoint</code> is <code>FALSE</code> or is not specified.</p>"
        }
      ]
    },
    "DestinationPorts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DestinationPorts"
        },
        {
          "description": "A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic."
        }
      ]
    },
    "AllowAllTrafficToEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericBoolean"
        },
        {
          "description": "<p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE. </p> <p>When set to TRUE, <i>all</i> destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p> <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.</p> <p>The default value is FALSE.</p>"
        }
      ]
    }
  },
  "required": [
    "EndpointGroupArn",
    "EndpointId"
  ]
}