Skip to main content

reverse_private_endpoints

Creates, updates, deletes, gets or lists a reverse_private_endpoints resource.

Overview​

Namereverse_private_endpoints
TypeResource
Idclickhouse.clickpipes.reverse_private_endpoints

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uuid)Reverse private endpoint ID. (example: 12345678-1234-1234-1234-123456789012)
endpoint_idstringReverse private endpoint endpoint ID. (example: vpce-12345678901234567) (wire: endpointId)
service_idstring (uuid)ClickHouse service ID reverse private endpoint is associated with. (example: 12345678-1234-1234-1234-123456789012) (wire: serviceId)
vpc_resource_configuration_idstringVPC resource configuration ID. Required for VPC_RESOURCE type. (example: rcfg-12345678901234567) (wire: vpcResourceConfigurationId)
vpc_endpoint_service_namestringVPC endpoint service name. (example: com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567) (wire: vpcEndpointServiceName)
custom_private_dns_mappingsarrayOptional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com (wire: customPrivateDnsMappings)
descriptionstringReverse private endpoint description. Maximum length is 255 characters. (example: My reverse private endpoint)
dns_namesarrayReverse private endpoint internal DNS names. (wire: dnsNames)
gcp_service_attachmentstringPrivate Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}. (example: projects/my-project/regions/us-central1/serviceAttachments/my-service) (wire: gcpServiceAttachment)
msk_authenticationstringMSK cluster authentication type. Required for MSK_MULTI_VPC type. (SASL_IAM, SASL_SCRAM) (example: SASL_IAM) (wire: mskAuthentication)
msk_cluster_arnstringMSK cluster ARN. Required for MSK_MULTI_VPC type. (example: arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster) (wire: mskClusterArn)
private_dns_namesarrayReverse private endpoint private DNS names. (wire: privateDnsNames)
statusstringReverse private endpoint status. (Unknown, Provisioning, Deleting, Ready, Failed, PendingAcceptance, Rejected, Expired) (example: Ready)
typestringReverse private endpoint type. (VPC_ENDPOINT_SERVICE, VPC_RESOURCE, MSK_MULTI_VPC, GCP_PSC_SERVICE_ATTACHMENT) (example: VPC_ENDPOINT_SERVICE)
vpc_resource_share_arnstringVPC resource share ARN. Required for VPC_RESOURCE type. (example: arn:aws🐏us-east-1:123456789012:resource-share/share-12345678901234567) (wire: vpcResourceShareArn)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_id, reverse_private_endpoint_id, organization_idReturns the reverse private endpoint with the specified ID.
listselectservice_id, organization_idReturns a list of reverse private endpoints for the specified service.
createinsertservice_id, organization_idCreate a new reverse private endpoint.
updateupdateservice_id, reverse_private_endpoint_id, organization_idUpdate mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.
deletedeleteservice_id, reverse_private_endpoint_id, organization_idDelete the reverse private endpoint with the specified ID.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
organization_idstringClickHouse Cloud organization ID. Resolved from the CLICKHOUSE_ORG_ID environment variable when it is set (x-stackQL-envVar); otherwise it must be supplied on every query as WHERE organization_id = <uuid>. A WHERE value always takes precedence over the environment. (x-stackQL-envVar: CLICKHOUSE_ORG_ID)
reverse_private_endpoint_idstring (uuid)ID of the reverse private endpoint to delete. (wire: reversePrivateEndpointId)
service_idstring (uuid)ID of the service that owns the Reverse Private Endpoint. (wire: serviceId)

SELECT examples​

Returns the reverse private endpoint with the specified ID.

SELECT
id,
endpoint_id,
service_id,
vpc_resource_configuration_id,
vpc_endpoint_service_name,
custom_private_dns_mappings,
description,
dns_names,
gcp_service_attachment,
msk_authentication,
msk_cluster_arn,
private_dns_names,
status,
type,
vpc_resource_share_arn
FROM clickhouse.clickpipes.reverse_private_endpoints
WHERE service_id = '{{ service_id }}' -- required
AND reverse_private_endpoint_id = '{{ reverse_private_endpoint_id }}' -- required
AND organization_id = '{{ organization_id }}' -- required unless CLICKHOUSE_ORG_ID is set
;

INSERT examples​

Create a new reverse private endpoint.

INSERT INTO clickhouse.clickpipes.reverse_private_endpoints (
description,
type,
vpc_endpoint_service_name,
vpc_resource_configuration_id,
vpc_resource_share_arn,
msk_cluster_arn,
msk_authentication,
gcp_service_attachment,
custom_private_dns_mappings,
service_id,
organization_id
)
SELECT 
'{{ description }}',
'{{ type }}',
'{{ vpc_endpoint_service_name }}',
'{{ vpc_resource_configuration_id }}',
'{{ vpc_resource_share_arn }}',
'{{ msk_cluster_arn }}',
'{{ msk_authentication }}',
'{{ gcp_service_attachment }}',
'{{ custom_private_dns_mappings }}',
'{{ service_id }}',
'{{ organization_id }}'
RETURNING
request_id,
result,
status
;

UPDATE examples​

Update mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.

UPDATE clickhouse.clickpipes.reverse_private_endpoints
SET 
custom_private_dns_mappings = '{{ custom_private_dns_mappings }}'
WHERE 
service_id = '{{ service_id }}' --required
AND reverse_private_endpoint_id = '{{ reverse_private_endpoint_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
RETURNING
request_id,
result,
status;

DELETE examples​

Delete the reverse private endpoint with the specified ID.

DELETE FROM clickhouse.clickpipes.reverse_private_endpoints
WHERE service_id = '{{ service_id }}' --required
AND reverse_private_endpoint_id = '{{ reverse_private_endpoint_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
;