Amazon PrivateLink · Schema
CreateVpcEndpointRequest
CreateVpcEndpointRequest schema from Amazon PrivateLink API
NetworkingPrivate ConnectivitySecurityVPCZero TrustEndpoint Services
Properties
| Name | Type | Description |
|---|---|---|
| VpcId | string | ID of the VPC for the endpoint |
| ServiceName | string | Service name for the endpoint |
| VpcEndpointType | string | Type of VPC endpoint |
| SubnetId | array | IDs of subnets for interface endpoints |
| SecurityGroupId | array | IDs of security groups for interface endpoints |
| PolicyDocument | string | Policy document for gateway endpoints |
| PrivateDnsEnabled | boolean | Enable private DNS for interface endpoints |
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-create-vpc-endpoint-request-schema.json",
"title": "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"
]
}