proxy_agents

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

Overview

Name	proxy_agents
Type	Resource
Id	fivetran.networking.proxy_agents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The unique identifier for the proxy agent within the Fivetran system. (example: id)
account_id	string	Fivetran Account ID. (example: account_id)
display_name	string	Proxy agent name. (example: display_name)
created_by	string	The actor who created the proxy agent. (example: created_by)
region	string	Data 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: GCP_US_EAST4)
registered_at	string (date-time)	The timestamp of the time the proxy agent was created in your account. (example: 2018-12-01T15:43:29.013729Z)
status	string	The connection status of the proxy agent. (NOT_FOUND, CONNECTED, NOT_CONNECTED) (example: CONNECTED)
usage	array	List of source connections and destinations using this proxy agent.
version	string	The version of the proxy agent. (example: 1.0.0)

list

Name	Datatype	Description
id	string	The unique identifier for the proxy agent within the Fivetran system. (example: id)
account_id	string	Fivetran Account ID. (example: account_id)
display_name	string	Proxy agent name. (example: display_name)
connector_count	integer (int32)	The number of source connections using the proxy agent.
created_by	string	The actor who created the proxy agent. (example: created_by)
destination_count	integer (int32)	The number of destinations using the proxy agent.
region	string	Data 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: GCP_US_EAST4)
registered_at	string (date-time)	The timestamp of the time the proxy agent was created in your account. (example: 2018-12-01T15:43:29.013729Z)
status	string	The connection status of the proxy agent. (NOT_FOUND, CONNECTED, NOT_CONNECTED) (example: CONNECTED)
version	string	The version of the proxy agent. (example: 1.0.0)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agent_id		Retrieves the details of the specified proxy agent.
list	select		cursor, limit	Returns a list of all proxy agents within your Fivetran account.
create	insert			Creates a new proxy agent within your Fivetran account.
delete	delete	agent_id		Deletes the specified proxy agent from your Fivetran account.
regenerate_secrets	exec	agent_id		Regenerate secrets for proxy agent within 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.

Name	Datatype	Description
agent_id	string	The unique identifier for the proxy agent within the Fivetran system.
cursor	string	Paging cursor, [read more about pagination](https:​//fivetran.com/docs/rest-api/pagination)
limit	integer (int32)	Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

SELECT examples

get

Retrieves the details of the specified proxy agent.

SELECT
id,
account_id,
display_name,
created_by,
region,
registered_at,
status,
usage,
version
FROM fivetran.networking.proxy_agents
WHERE agent_id = '{{ agent_id }}' -- required
;

list

Returns a list of all proxy agents within your Fivetran account.

SELECT
id,
account_id,
display_name,
connector_count,
created_by,
destination_count,
region,
registered_at,
status,
version
FROM fivetran.networking.proxy_agents
WHERE "limit" = '{{ limit }}'
;

INSERT examples

create

Creates a new proxy agent within your Fivetran account.

INSERT INTO fivetran.networking.proxy_agents (
display_name,
group_region
)
SELECT 
'{{ display_name }}',
'{{ group_region }}'
RETURNING
agent_id,
auth_token,
client_cert,
client_private_key,
orchestrator_host,
orchestrator_port
;

Manifest

# Description fields are for documentation purposes
- name: proxy_agents
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Proxy agent name.
  - name: group_region
    value: "{{ group_region }}"
    description: |
      Data processing location. This is where Fivetran will operate and run computation on data (optional).
    valid_values: ['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']

DELETE examples

delete

Deletes the specified proxy agent from your Fivetran account.

DELETE FROM fivetran.networking.proxy_agents
WHERE agent_id = '{{ agent_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

regenerate_secrets

Regenerate secrets for proxy agent within your Fivetran account.

EXEC fivetran.networking.proxy_agents.regenerate_secrets 
@agent_id='{{ agent_id }}' --required
;