private_network_gateways

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

Overview

Name	private_network_gateways
Type	Resource
Id	databricks_account.networking.private_network_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The canonical resource name of the gateway, in the form ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``.
display_name	string	The human-readable name of the gateway.
▶aws_cloud_connection	object	The AWS connection used by the gateway.
▶azure_cloud_connection	object	The Azure connection used by the gateway.
bandwidth_tier_gigabits_per_second	integer	The provisioned bandwidth tier for an Azure gateway, in gigabits per second. Required when creating an Azure gateway.
create_time	string (date-time)	The time when the gateway was created.
▶destinations	array	The destinations routed through this gateway.
error_message	string	The failure reason when the gateway is in the FAILED state.
▶private_dns_resolvers	array	The DNS resolvers used for private name resolution.
state	string	The current lifecycle state of the gateway. (CREATING, DELETING, ESTABLISHED, FAILED)
traffic_mode	string	The traffic routed through this gateway. (ALL_TRAFFIC, SPECIFIC_DESTINATIONS)
update_time	string (date-time)	The time when the gateway was last updated.

list

Name	Datatype	Description
name	string	The canonical resource name of the gateway, in the form ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``.
display_name	string	The human-readable name of the gateway.
▶aws_cloud_connection	object	The AWS connection used by the gateway.
▶azure_cloud_connection	object	The Azure connection used by the gateway.
bandwidth_tier_gigabits_per_second	integer	The provisioned bandwidth tier for an Azure gateway, in gigabits per second. Required when creating an Azure gateway.
create_time	string (date-time)	The time when the gateway was created.
▶destinations	array	The destinations routed through this gateway.
error_message	string	The failure reason when the gateway is in the FAILED state.
▶private_dns_resolvers	array	The DNS resolvers used for private name resolution.
state	string	The current lifecycle state of the gateway. (CREATING, DELETING, ESTABLISHED, FAILED)
traffic_mode	string	The traffic routed through this gateway. (ALL_TRAFFIC, SPECIFIC_DESTINATIONS)
update_time	string (date-time)	The time when the gateway was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, ncc_id, gateway_id, account_host		Gets a private network gateway.
list	select	account_id, ncc_id, account_host	page_token	Lists private network gateways under a network connectivity configuration.
create	insert	account_id, ncc_id, account_host, display_name, traffic_mode	request_id	Creates a private network gateway.
update	update	account_id, ncc_id, gateway_id, update_mask, account_host, display_name, traffic_mode		Updates a private network gateway.
delete	delete	account_id, ncc_id, gateway_id, account_host		Permanently deletes a private network gateway.

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
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string	The account_id segment of the name resource name (accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}). The canonical resource name of the gateway.
gateway_id	string	The gateway_id segment of the name resource name (accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}). The canonical resource name of the gateway.
ncc_id	string	The ncc_id segment of the name resource name (accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}). The canonical resource name of the gateway.
update_mask	object	The fields to update.
page_token	string	An opaque token returned by a previous list request.
request_id	string	A unique identifier for this request. The request is idempotent when this is provided.

SELECT examples

get

Gets a private network gateway.

SELECT
name,
display_name,
aws_cloud_connection,
azure_cloud_connection,
bandwidth_tier_gigabits_per_second,
create_time,
destinations,
error_message,
private_dns_resolvers,
state,
traffic_mode,
update_time
FROM databricks_account.networking.private_network_gateways
WHERE account_id = '{{ account_id }}' -- required
AND ncc_id = '{{ ncc_id }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

list

Lists private network gateways under a network connectivity configuration.

SELECT
name,
display_name,
aws_cloud_connection,
azure_cloud_connection,
bandwidth_tier_gigabits_per_second,
create_time,
destinations,
error_message,
private_dns_resolvers,
state,
traffic_mode,
update_time
FROM databricks_account.networking.private_network_gateways
WHERE account_id = '{{ account_id }}' -- required
AND ncc_id = '{{ ncc_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a private network gateway.

INSERT INTO databricks_account.networking.private_network_gateways (
display_name,
traffic_mode,
aws_cloud_connection,
azure_cloud_connection,
bandwidth_tier_gigabits_per_second,
create_time,
destinations,
error_message,
name,
private_dns_resolvers,
state,
update_time,
account_id,
ncc_id,
account_host,
request_id
)
SELECT 
'{{ display_name }}' /* required */,
'{{ traffic_mode }}' /* required */,
'{{ aws_cloud_connection }}',
'{{ azure_cloud_connection }}',
{{ bandwidth_tier_gigabits_per_second }},
'{{ create_time }}',
'{{ destinations }}',
'{{ error_message }}',
'{{ name }}',
'{{ private_dns_resolvers }}',
'{{ state }}',
'{{ update_time }}',
'{{ account_id }}',
'{{ ncc_id }}',
'{{ account_host }}',
'{{ request_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: private_network_gateways
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the private_network_gateways resource.
  - name: ncc_id
    value: "{{ ncc_id }}"
    description: Required parameter for the private_network_gateways resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the private_network_gateways resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      The human-readable name of the gateway.
  - name: traffic_mode
    value: "{{ traffic_mode }}"
    description: |
      The traffic routed through this gateway.
  - name: aws_cloud_connection
    description: |
      The AWS connection used by the gateway.
    value:
      gateway_subnets:
        - subnet_id: "{{ subnet_id }}"
      cross_account_role:
        role_arn: "{{ role_arn }}"
      security_group_ids:
        - "{{ security_group_ids }}"
  - name: azure_cloud_connection
    description: |
      The Azure connection used by the gateway.
    value:
      gateway_subnet:
        resource_id: "{{ resource_id }}"
  - name: bandwidth_tier_gigabits_per_second
    value: {{ bandwidth_tier_gigabits_per_second }}
    description: |
      The provisioned bandwidth tier for an Azure gateway, in gigabits per second. Required when creating an Azure gateway.
  - name: create_time
    value: "{{ create_time }}"
    description: |
      The time when the gateway was created.
  - name: destinations
    description: |
      The destinations routed through this gateway.
    value:
      - destination_type: "{{ destination_type }}"
        value: "{{ value }}"
  - name: error_message
    value: "{{ error_message }}"
    description: |
      The failure reason when the gateway is in the FAILED state.
  - name: name
    value: "{{ name }}"
    description: |
      The canonical resource name of the gateway, in the form ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``.
  - name: private_dns_resolvers
    description: |
      The DNS resolvers used for private name resolution.
    value:
      - resolver_type: "{{ resolver_type }}"
        value: "{{ value }}"
  - name: state
    value: "{{ state }}"
    description: |
      The current lifecycle state of the gateway.
  - name: update_time
    value: "{{ update_time }}"
    description: |
      The time when the gateway was last updated.
  - name: request_id
    value: "{{ request_id }}"
    description: A unique identifier for this request. The request is idempotent when this is provided.
    description: A unique identifier for this request. The request is idempotent when this is provided.

UPDATE examples

update

Updates a private network gateway.

UPDATE databricks_account.networking.private_network_gateways
SET 
display_name = '{{ display_name }}',
traffic_mode = '{{ traffic_mode }}',
aws_cloud_connection = '{{ aws_cloud_connection }}',
azure_cloud_connection = '{{ azure_cloud_connection }}',
bandwidth_tier_gigabits_per_second = {{ bandwidth_tier_gigabits_per_second }},
create_time = '{{ create_time }}',
destinations = '{{ destinations }}',
error_message = '{{ error_message }}',
name = '{{ name }}',
private_dns_resolvers = '{{ private_dns_resolvers }}',
state = '{{ state }}',
update_time = '{{ update_time }}'
WHERE 
account_id = '{{ account_id }}' --required
AND ncc_id = '{{ ncc_id }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND update_mask = '{{ update_mask }}' --required
AND account_host = '{{ account_host }}' --required
AND display_name = '{{ display_name }}' --required
AND traffic_mode = '{{ traffic_mode }}' --required
RETURNING
name,
display_name,
aws_cloud_connection,
azure_cloud_connection,
bandwidth_tier_gigabits_per_second,
create_time,
destinations,
error_message,
private_dns_resolvers,
state,
traffic_mode,
update_time;

DELETE examples

delete

Permanently deletes a private network gateway.

DELETE FROM databricks_account.networking.private_network_gateways
WHERE account_id = '{{ account_id }}' --required
AND ncc_id = '{{ ncc_id }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND account_host = '{{ account_host }}' --required
;