Amazon Privatelink Create Vpc Endpoint Request Structure

CreateVpcEndpointRequest schema from Amazon PrivateLink API

Type: object Properties: 7 Required: 2

NetworkingPrivate ConnectivitySecurityVPCZero TrustEndpoint Services

CreateVpcEndpointRequest is a JSON Structure definition published by Amazon PrivateLink, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

VpcId ServiceName VpcEndpointType SubnetId SecurityGroupId PolicyDocument PrivateDnsEnabled

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-privatelink/refs/heads/main/json-structure/amazon-privatelink-create-vpc-endpoint-request-structure.json",
  "name": "CreateVpcEndpointRequest",
  "description": "CreateVpcEndpointRequest schema from Amazon PrivateLink API",
  "type": "object",
  "properties": {
    "VpcId": {
      "type": "string",
      "description": "ID of the VPC for the endpoint"
    },
    "ServiceName": {
      "type": "string",
      "description": "Service name for the endpoint"
    },
    "VpcEndpointType": {
      "type": "string",
      "enum": [
        "Interface",
        "Gateway",
        "GatewayLoadBalancer"
      ],
      "description": "Type of VPC endpoint"
    },
    "SubnetId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of subnets for interface endpoints"
    },
    "SecurityGroupId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of security groups for interface endpoints"
    },
    "PolicyDocument": {
      "type": "string",
      "description": "Policy document for gateway endpoints"
    },
    "PrivateDnsEnabled": {
      "type": "boolean",
      "description": "Enable private DNS for interface endpoints"
    }
  },
  "required": [
    "VpcId",
    "ServiceName"
  ]
}