private_endpoint_configs

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

Overview

Name	private_endpoint_configs
Type	Resource
Id	clickhouse.organizations.private_endpoint_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
endpoint_service_id	string	Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource (wire: endpointServiceId)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cloud_provider, region_id, organization_id		Deprecated. Please follow [documentation](https:​//clickhouse.com/docs/manage/security/aws-privatelink#add-endpoint-id-to-services-allow-list) for the updated process.

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.

Name	Datatype	Description
cloud_provider	string	Cloud provider identifier. One of aws, gcp, or azure.
organization_id	string	ClickHouse 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)
region_id	string	Region identifier within specific cloud providers.

SELECT examples

get

Deprecated. Please follow documentation for the updated process.

SELECT
endpoint_service_id
FROM clickhouse.organizations.private_endpoint_configs
WHERE cloud_provider = '{{ cloud_provider }}' -- required
AND region_id = '{{ region_id }}' -- required
AND organization_id = '{{ organization_id }}' -- required unless CLICKHOUSE_ORG_ID is set
;