Amazon PrivateLink · Schema
ServiceConfiguration
ServiceConfiguration schema from Amazon PrivateLink API
NetworkingPrivate ConnectivitySecurityVPCZero TrustEndpoint Services
Properties
| Name | Type | Description |
|---|---|---|
| ServiceType | array | Type of service (Interface or Gateway) |
| ServiceId | string | Unique ID of the endpoint service |
| ServiceName | string | Name of the endpoint service |
| ServiceState | string | State of the endpoint service |
| AcceptanceRequired | boolean | Whether connections require acceptance |
| AvailabilityZones | array | Availability zones where the service is available |
| NetworkLoadBalancerArns | array | ARNs of Network Load Balancers |
| PrivateDnsName | string | Private DNS name |
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-service-configuration-schema.json",
"title": "ServiceConfiguration",
"description": "ServiceConfiguration schema from Amazon PrivateLink API",
"type": "object",
"properties": {
"ServiceType": {
"type": "array",
"items": {
"type": "object"
},
"description": "Type of service (Interface or Gateway)"
},
"ServiceId": {
"type": "string",
"description": "Unique ID of the endpoint service"
},
"ServiceName": {
"type": "string",
"description": "Name of the endpoint service"
},
"ServiceState": {
"type": "string",
"enum": [
"Pending",
"Available",
"Deleting",
"Deleted",
"Failed"
],
"description": "State of the endpoint service"
},
"AcceptanceRequired": {
"type": "boolean",
"description": "Whether connections require acceptance"
},
"AvailabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Availability zones where the service is available"
},
"NetworkLoadBalancerArns": {
"type": "array",
"items": {
"type": "string"
},
"description": "ARNs of Network Load Balancers"
},
"PrivateDnsName": {
"type": "string",
"description": "Private DNS name"
}
}
}