Amazon Global Accelerator · JSON Structure

Global Accelerator Port Mapping Structure

Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.

Type: object Properties: 6
AvailabilityCDNGlobalLoad BalancingNetworkingPerformance

PortMapping is a JSON Structure definition published by Amazon Global Accelerator, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AcceleratorPort EndpointGroupArn EndpointId DestinationSocketAddress Protocols DestinationTrafficState

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-global-accelerator/refs/heads/main/json-structure/global-accelerator-port-mapping-structure.json",
  "name": "PortMapping",
  "description": "Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets. ",
  "type": "object",
  "properties": {
    "AcceleratorPort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortNumber"
        },
        {
          "description": "The accelerator port."
        }
      ]
    },
    "EndpointGroupArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the endpoint group."
        }
      ]
    },
    "EndpointId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The IP address of the VPC subnet (the subnet ID)."
        }
      ]
    },
    "DestinationSocketAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SocketAddress"
        },
        {
          "description": "The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet."
        }
      ]
    },
    "Protocols": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomRoutingProtocols"
        },
        {
          "description": "The protocols supported by the endpoint group."
        }
      ]
    },
    "DestinationTrafficState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomRoutingDestinationTrafficState"
        },
        {
          "description": "Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination."
        }
      ]
    }
  }
}