Skip to main content

private_links

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

Overview​

Nameprivate_links
TypeResource
Idfivetran.networking.private_links

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe unique identifier for the private link within the Fivetran system. (example: private_link_id)
namestringPrivate link name (example: PrivateLinkName)
account_idstring
cloud_providerstringPrivate link cloud provider (AWS, GCP, AZURE) (example: AWS)
configobjectThe config object for the service in question (a JSON value; its keys depend on the service). The accepted keys per type are documented in the vendor's API reference and returned by the connector metadata endpoints.
created_atstring (date-time)The timestamp of the time the private link was created in your account (example: 2023-12-01T15:43:29.013729Z)
created_bystringThe actor who created the private link (example: user_id)
hoststringThe DNS name of the PrivateLink endpoint service. (example: example.host.com)
regionstringData processing location. This is where Fivetran will operate and run computation on data. (GCP_US_EAST4, GCP_US_WEST1, GCP_US_CENTRAL1, GCP_EUROPE_WEST3, GCP_AUSTRALIA_SOUTHEAST1, GCP_NORTHAMERICA_NORTHEAST1, GCP_EUROPE_WEST2, GCP_ASIA_SOUTHEAST1, GCP_ASIA_SOUTHEAST2, GCP_ASIA_SOUTH1, GCP_ASIA_NORTHEAST1, GCP_ASIA_NORTHEAST3, GCP_ME_CENTRAL2, AWS_US_EAST_1, AWS_US_EAST_2, AWS_US_WEST_2, AWS_AP_NORTHEAST_1, AWS_AP_NORTHEAST_2, AWS_AP_SOUTHEAST_1, AWS_AP_SOUTHEAST_2, AWS_EU_CENTRAL_1, AWS_EU_NORTH_1, AWS_EU_WEST_1, AWS_EU_WEST_2, AWS_EU_WEST_3, AWS_AP_SOUTH_1, AWS_CA_CENTRAL_1, AWS_US_GOV_WEST_1, AZURE_EASTUS2, AZURE_AUSTRALIAEAST, AZURE_UKSOUTH, AZURE_WESTEUROPE, AZURE_CENTRALUS, AZURE_CANADACENTRAL, AZURE_UAENORTH, AZURE_SOUTHEASTASIA, AZURE_EASTUS, AZURE_JAPANEAST, AZURE_CENTRALINDIA, AZURE_GERMANYWESTCENTRAL, AZURE_WESTUS3, AZURE_SWITZERLANDNORTH, AZURE_KOREACENTRAL) (example: AWS_US_EAST_1)
resource_upstream_statusstringThe upstream status of the PrivateLink resource as reported by the cloud provider. (example: IDLE)
servicestringThe name for the service type within the Fivetran system. (DATABRICKS_AWS, SNOWFLAKE_AWS, REDSHIFT_AWS, SOURCE_AWS, DATABRICKS_AZURE, SNOWFLAKE_AZURE, ONELAKE_AZURE, POSTGRES_WAREHOUSE_AZURE, SQL_DATA_WAREHOUSE_AZURE, SOURCE_AZURE, SNOWFLAKE_GCP, SOURCE_GCP, DATABRICKS_GCP) (example: DATABRICKS)
statestringPrivate link state (CREATING, UPDATING, DESTROYING, OK, FAIL) (example: OK)
state_summarystringPrivate link state summary (example: ...)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprivate_link_idReturns a private link object if a valid identifier was provided.
listselectcursor, limitReturns a list of all private links.
createinsertconfig, name, region, serviceCreates a new private link in your Fivetran account. <br /><br />> NOTE: See the [Set Up a Connection With Private Links tutorial](https:​//fivetran.com/docs/rest-api/tutorials/set-up-connection-with-private-links) to learn how to use this endpoint to set up a [database connection](https:​//fivetran.com/docs/connectors/databases) with [private networking](https:​//fivetran.com/docs/using-fivetran/features#privatenetworking).<br />
updateupdateprivate_link_idUpdates information for an existing private link within your Fivetran account.
deletedeleteprivate_link_idDeletes a private link from your Fivetran account.

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
cursorstringPaging cursor, [read more about pagination](https:​//fivetran.com/docs/rest-api/pagination)
limitinteger (int32)Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

SELECT examples​

Returns a private link object if a valid identifier was provided.

SELECT
id,
name,
account_id,
cloud_provider,
config,
created_at,
created_by,
host,
region,
resource_upstream_status,
service,
state,
state_summary
FROM fivetran.networking.private_links
WHERE private_link_id = '{{ private_link_id }}' -- required
;

INSERT examples​

Creates a new private link in your Fivetran account. <br /><br />> NOTE: See the [Set Up a Connection With Private Links tutorial](https:​//fivetran.com/docs/rest-api/tutorials/set-up-connection-with-private-links) to learn how to use this endpoint to set up a [database connection](https:​//fivetran.com/docs/connectors/databases) with [private networking](https:​//fivetran.com/docs/using-fivetran/features#privatenetworking).<br />

INSERT INTO fivetran.networking.private_links (
name,
region,
service,
config
)
SELECT 
'{{ name }}' /* required */,
'{{ region }}' /* required */,
'{{ service }}' /* required */,
'{{ config }}' /* required */
RETURNING
id,
name,
account_id,
cloud_provider,
config,
created_at,
created_by,
host,
region,
resource_upstream_status,
service,
state,
state_summary
;

UPDATE examples​

Updates information for an existing private link within your Fivetran account.

UPDATE fivetran.networking.private_links
SET 
config = '{{ config }}'
WHERE 
private_link_id = '{{ private_link_id }}' --required
RETURNING
id,
name,
account_id,
cloud_provider,
config,
created_at,
created_by,
host,
region,
resource_upstream_status,
service,
state,
state_summary;

DELETE examples​

Deletes a private link from your Fivetran account.

DELETE FROM fivetran.networking.private_links
WHERE private_link_id = '{{ private_link_id }}' --required
;
Last updated on