VpcEndpoint

VpcEndpoint schema from Amazon PrivateLink API

NetworkingPrivate ConnectivitySecurityVPCZero TrustEndpoint Services

Properties

Name	Type	Description
VpcEndpointId	string	ID of the VPC endpoint
VpcEndpointType	string	Type of VPC endpoint
VpcId	string	ID of the VPC
ServiceName	string	Name of the service
State	string	State of the endpoint
PolicyDocument	string	Policy document
SubnetIds	array	Subnet IDs for interface endpoints
NetworkInterfaceIds	array	Network interface IDs
DnsEntries	array	DNS entries for the endpoint

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-privatelink/refs/heads/main/json-schema/amazon-privatelink-vpc-endpoint-schema.json",
  "title": "VpcEndpoint",
  "description": "VpcEndpoint schema from Amazon PrivateLink API",
  "type": "object",
  "properties": {
    "VpcEndpointId": {
      "type": "string",
      "description": "ID of the VPC endpoint"
    },
    "VpcEndpointType": {
      "type": "string",
      "description": "Type of VPC endpoint"
    },
    "VpcId": {
      "type": "string",
      "description": "ID of the VPC"
    },
    "ServiceName": {
      "type": "string",
      "description": "Name of the service"
    },
    "State": {
      "type": "string",
      "enum": [
        "PendingAcceptance",
        "Pending",
        "Available",
        "Deleting",
        "Deleted",
        "Rejected",
        "Failed",
        "Expired"
      ],
      "description": "State of the endpoint"
    },
    "PolicyDocument": {
      "type": "string",
      "description": "Policy document"
    },
    "SubnetIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Subnet IDs for interface endpoints"
    },
    "NetworkInterfaceIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Network interface IDs"
    },
    "DnsEntries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DnsName": {
            "type": "string"
          },
          "HostedZoneId": {
            "type": "string"
          }
        }
      },
      "description": "DNS entries for the endpoint"
    }
  }
}